Skip to content

Commit

Permalink
Fix tags and headers in sphinx-doc output (#11)
Browse files Browse the repository at this point in the history
* Fix tags and headers in sphinx-doc output

* Move documentation action to correct path
  • Loading branch information
janbridley authored Nov 27, 2024
1 parent 2523978 commit c682297
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 15 deletions.
File renamed without changes.
10 changes: 6 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ build from source to install the package.
# Install to your python environment!
python -m pip install .
.. _quickstartexample:

Quickstart Example
==================
Expand Down Expand Up @@ -91,10 +92,11 @@ Quickstart Example
* - Isometric
- Dimetric
- Trimetric
* - .. image:: _static/iso.svg
- .. image:: _static/dim.svg
- .. image:: _static/tri.svg
* - .. image:: doc/source/_static/iso.svg
- .. image:: doc/source/_static/dim.svg
- .. image:: doc/source/_static/tri.svg

.. _usageexample:

Usage Example
=============
Expand Down Expand Up @@ -166,4 +168,4 @@ In addition to convenience methods, `svg3d` allows full control over the viewpor
Running the code above generates the following image:

.. image:: _static/cube-wireframe.svg
.. image:: doc/source/_static/cube-wireframe.svg
2 changes: 1 addition & 1 deletion doc/source/_static/truncated_cube.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@

.. include:: ../../README.rst
:start-after: .. _imheader:
:end-before: Usage Example
:end-before: .. _quickstartexample:

.. include:: quickstart.rst

.. toctree::
:maxdepth: 2
Expand Down
17 changes: 12 additions & 5 deletions doc/source/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Quickstart Example
==================

.. include:: ../../README.rst
:start-after: Quickstart Example
:end-before: Usage Example
:start-after: .. _quickstartexample:
:end-before: .. list-table::

.. list-table::
:header-rows: 1

* - Isometric
- Dimetric
- Trimetric
* - .. image:: _static/iso.svg
- .. image:: _static/dim.svg
- .. image:: _static/tri.svg
8 changes: 4 additions & 4 deletions doc/source/usage-example.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Usage Example
==================

.. include:: ../../README.rst
:start-after: Usage Example
:start-after: .. _usageexample:
:end-before: Running the code above generates the following image

.. image:: _static/cube-wireframe.svg

0 comments on commit c682297

Please sign in to comment.