diff --git a/doc/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml similarity index 100% rename from doc/.github/workflows/documentation.yaml rename to .github/workflows/documentation.yaml diff --git a/README.rst b/README.rst index 7a2b368..ce16a3c 100644 --- a/README.rst +++ b/README.rst @@ -50,6 +50,7 @@ build from source to install the package. # Install to your python environment! python -m pip install . +.. _quickstartexample: Quickstart Example ================== @@ -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 ============= @@ -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 diff --git a/doc/source/_static/truncated_cube.svg b/doc/source/_static/truncated_cube.svg index b3dbd71..dd69d4e 100644 --- a/doc/source/_static/truncated_cube.svg +++ b/doc/source/_static/truncated_cube.svg @@ -1,2 +1,2 @@ - \ No newline at end of file + diff --git a/doc/source/index.rst b/doc/source/index.rst index a6bab5e..4ec27d3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -23,7 +23,9 @@ .. include:: ../../README.rst :start-after: .. _imheader: - :end-before: Usage Example + :end-before: .. _quickstartexample: + +.. include:: quickstart.rst .. toctree:: :maxdepth: 2 diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index af06298..338e380 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -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 diff --git a/doc/source/usage-example.rst b/doc/source/usage-example.rst index 288a756..734a174 100644 --- a/doc/source/usage-example.rst +++ b/doc/source/usage-example.rst @@ -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