Fix documentation failure due to pinned sphinx version

.github/workflows/publish.yml

@@ -32,3 +32,14 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Get documentation dependencies
+        run: |
+          sudo apt install pandoc
+          pip install -r doc-requirements.txt
+
+      - name: Check if documentation builds succesfully
+        run: |
+          pip install .
+          cd docs
+          make html          

.gitignore

@@ -111,3 +111,6 @@ docs/_build
 tests/_*
 docs/_*
 result_images/*
+
+# package specific content
+tests/result_images/*

dev-requirements.txt

@@ -2,4 +2,4 @@
 pytest>=4.6 # bumped for compatibility with latest pytest-cov
 pytest-cov
 wheel
-matplotlib
+tox

doc-requirements.txt

@@ -1,10 +1,10 @@
-Sphinx==4.3.2
+Sphinx
 nbsphinx
 jupyter_client
 ipykernel
-sphinx_rtd_theme==1.0.0
+sphinx_rtd_theme
 matplotlib
-Pygments==2.11.2
-click==8.0.3
-pandoc==2.0.1
-Jinja2==3.0.3
+Pygments
+click
+pandoc
+Jinja2

docs/invoer.rst

@@ -32,7 +32,10 @@ Hieronder wordt voor elk van de mogelijke invoerrasters een omschrijving gegeven
 Onderstaande figuur geeft de verschillende invoerrasters weer, thematisch geordend (verticaal) en ingedeeld naar hun indirecte (via zuur- en trofiegraad) en directe invloed op de potenties voor de verschillende vegetatietypen (horizontaal).
 
 .. figure:: _static/svg/input_rasters.svg
-   :scale: 100%
+    :scale: 100%
+    :width: 960px
+    :height: 720px
+    :alt: Overview of the required raster inputs for the Niche-Vlaanderen model.
 
 .. _soil_code:
 

docs/notendop.rst

@@ -19,7 +19,10 @@ Onderstaande figuur tracht de werking van zowel het NICHE Vlaanderen model als d
 De hyperlinks in de figuur verwijzen je door naar de documentatie bij het betreffende item.
 
 .. figure:: _static/svg/NICHE_summary_extended.svg
-   :scale: 100%
+    :scale: 100%
+    :width: 1092px
+    :height: 935px
+    :alt: Functional overview of the Niche-Vlaanderen model and post-flooding module.
 
 Doel van deze website
 =====================

docs/running.rst

@@ -13,8 +13,9 @@ and activate the environment (in this example, an environment you called `niche`
 Optionally - Jupyter Notebook
 =============================
 
-If you want to run niche_vlaanderen interactively, we recommend using a [jupyter notebook](http://jupyter.org/).
-To run this, from the `Anaconda/Miniconda prompt` do:
+If you want to run niche_vlaanderen interactively, we recommend using a  `Jupyter notebook <http://jupyter.org/>`_.
+
+To use Jupyter Notebooks, from the `Anaconda/Miniconda prompt` do:
 
 .. code-block:: default
 

docs/vegetatie_reftabel.rst

@@ -11,8 +11,8 @@ Opbouw referentietabel
 
 De referentietabel van NICHE Vlaanderen kan je `hier <https://github.com/inbo/niche_vlaanderen/blob/master/niche_vlaanderen/system_tables/niche_vegetation.csv>`_ raadplegen. Ze bevat de standplaatsvereisten voor elk vegetatietype, vertaald naar 7 verschillende standplaatsfactoren. De links in onderstaand lijstje verwijzen door naar meer informatie bij de standplaatsfactoren en de aard van de gegevens.
 
-- :doc:`Cijfercode NICHE vegetatietype <vegetatietype.rst>`
-- :doc:`Wetenschappelijke naam NICHE vegetatietype <vegetatietype.rst>`
+- :doc:`Cijfercode NICHE vegetatietype <vegetatietype>`
+- :doc:`Wetenschappelijke naam NICHE vegetatietype <vegetatietype>`
 - :ref:`Bodemtype <soil_code>`
 - :doc:`Trofiegraad <trofie>`
 - :doc:`Zuurgraad <zuur>`

requirements.txt

@@ -1,8 +1,9 @@
 pandas
 numpy
+matplotlib
 rasterio
 pyyaml
 rasterstats>=0.17
 geopandas
 pygeos
-tqdm
+tqdm

setup.py

@@ -18,10 +18,12 @@
 requirements = [
         'pandas',
         'numpy',
+        'matplotlib',
         'rasterio',
         'pyyaml',
         'rasterstats>=0.17',
         'tqdm',
+        'pygeos',
         'geopandas'
         ]