✨ Add initial version

Author: chrisjsewell

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10"]
         os: [ubuntu-latest]
         include:
         - os: windows-latest

.readthedocs.yml

@@ -7,12 +7,8 @@ python:
       path: .
       extra_requirements:
       - docs
+      - furo
 
 sphinx:
   builder: html
   fail_on_warning: true
-
-# Also build PDF & ePub
-formats:
-  - epub
-  - pdf

README.md

@@ -1,55 +1,36 @@
-# sphinx-subfigure
+# sphinx-timeline
 
 [![PyPI][pypi-badge]][pypi-link]
 
-A [sphinx](https://www.sphinx-doc.org) extension to create figures with multiple images:
-
-- Provides a simple format for complex image layouts.
-- Supports HTML fully, with responsive layouts, for different screen sizes
-  - LaTeX is supported, except for images that span multiple rows.
-  - degrades gracefully for other formats.
-- Supports figure numbering and referencing.
-- Supports image sub-captions, via `alt` text.
+A [sphinx](https://www.sphinx-doc.org) extension to create timelines.
 
 ## Usage
 
-Install `sphinx-subfigure` with `pip install sphinx-subfigure`,
-then add `sphinx_subfigure` to your `conf.py` file's `extensions` variable:
+Install `sphinx-timeline` with `pip install sphinx-timeline`,
+then add `sphinx_timeline` to your `conf.py` file's `extensions` variable:
 
 ```python
-extensions = ["sphinx_subfigure"]
+extensions = ["sphinx_timeline"]
 
 numfig = True  # optional
 ```
 
-Now add a `subfigure` directive to your document:
+Now add a `timeline` directive to your document:
 
 ```restructuredtext
-.. subfigure:: AA|BC
-   :layout-sm: A|B|C
-   :subcaptions: above
-   :name: myfigure
-   :class-grid: outline
-
-   .. image:: imageA.png
-      :alt: Image A
-
-   .. image:: imageB.png
-      :alt: Image B
-
-   .. image:: imageC.png
-      :alt: Image C
-
-    Figure Caption
+.. timeline::
+   - start: 1980-02-03
+     name: 1st event
+   - start: 1990-02-03
+     name: 2nd event
+   - start: 2000-02-03
+     name: 3rd event
+   ---
+   **{{e.start|fdtime}}**:
+   *{{e.name}}*
+
+   Description ...
 ```
 
-1. Each image is automatically assigned an *area identifier* (A, B, C, etc.).
-2. Layouts are formed by composing the areas into a grid, with rows delimited by `|`.
-3. Each area must be used exactly once in the layout, and form a single rectangle.
-4. "Empty" areas can be designated with `.`
-5. Additional layouts can be defined with `:layout-sm:`, `:layout-lg:`, `:layout-xl:`, for different screen sizes (HTML only).
-
-![Responsive sub-figure](subfigure-responsive.gif)
-
-[pypi-badge]: https://img.shields.io/pypi/v/sphinx_subfigure.svg
-[pypi-link]: https://pypi.org/project/sphinx_subfigure
+[pypi-badge]: https://img.shields.io/pypi/v/sphinx_timeline.svg
+[pypi-link]: https://pypi.org/project/sphinx_timeline