update documentation

Author: Anne Hartebrodt

.github/workflows/static.yaml

@@ -20,9 +20,11 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx-rtd-theme
-          pip install . # This installs your package so Sphinx can import it
-
+          python -m pip install --upgrade pip
+          pip install sphinx sphinx-rtd-theme sphinx-autodoc-typehints
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install . # Install the local package to make it importable
+          
       - name: Build Sphinx Documentation
         run: |
           sphinx-build -b html docs/source docs/build/html

docs/source/index.rst

@@ -15,3 +15,5 @@ documentation for details.
    :maxdepth: 2
    :caption: Contents:
 
+   modules
+

docs/source/modules.rst

@@ -1,7 +1,7 @@
-netmap
-======
+API Reference
+=============
 
-.. toctree::
-   :maxdepth: 4
-
-   netmap
+.. automodule:: netmap
+   :members:
+   :undoc-members:
+   :show-inheritance: