More doc on docs site

CQCL · Oct 3, 2023 · c184306 · c184306
1 parent 9e52a5e
commit c184306
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 2 deletions.
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -31,7 +31,7 @@ jobs:
         python -m pytest
     - name: Sphinx documentation build
       run: |
-        sphinx-build -M html docs/source/ docs/build/
+        make docs
     - name: Deploy to GitHub Pages
       uses: peaceiris/actions-gh-pages@v3
       if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,7 @@ __pypackages__/
 .DS_Store
 .qtmlib/
 *.venv/
+
+# autogenerated by sphinx-napoleon
+docs/source/modules.rst
+docs/source/pytemplate.rst
diff --git a/Makefile b/Makefile
@@ -13,6 +13,7 @@ lint:
 	pre-commit run --all-files
 
 docs:
+	sphinx-apidoc -f -o docs/source/ pytemplate
 	sphinx-build -M html docs/source/ docs/build/
 
 clean:

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -3,6 +3,13 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here.
+import pathlib
+import sys
+
+sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
@@ -14,7 +21,12 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = [
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+]
 
 exclude_patterns = []
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,10 +1,16 @@
 qtmlib
 ======
 
+Demo Sphinx site for the `CQCL pytemplate <https://github.com/CQCL/pytemplate>`_ project.
+
+----
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   modules
+
 Installation
 ------------
 
@@ -41,4 +47,5 @@ Indices and tables
 ==================
 
 * :ref:`genindex`
+* :ref:`modindex`
 * :ref:`search`