Merge ad1b317 into bf27f81

.github/workflows/ci.yaml

@@ -33,7 +33,16 @@ jobs:
           python -m black . --diff --check --verbose
           python -m isort . --diff --check-only --verbose
           python -m flake8 momentGW/ --verbose
-      - name: Run unit tests
+      #- name: Run unit tests
+      #  run: |
+      #    python -m pip install pytest pytest-cov
+      #    pytest --cov momentGW/
+      - name: Build documentation
         run: |
-          python -m pip install pytest pytest-cov
-          pytest --cov momentGW/
+          cd docs
+          make html
+      - name: Deploy documentation
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html

docs/Makefile

@@ -0,0 +1,13 @@
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+html:
+	sphinx-apidoc -o api/ ../momentGW --force --separate
+	sphinx-build -M html . _build
+
+clean:
+	rm -rf _build api
+
+.PHONY: html

docs/api.rst

@@ -0,0 +1,8 @@
+API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api/modules

docs/conf.py

@@ -0,0 +1,22 @@
+# docs/conf.py
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../"))
+
+project = "momentGW"
+copyright = "2024, Oliver J. Backhouse"
+author = "Oliver J. Backhouse"
+
+extensions = [
+    "sphinx_mdinclude",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.autodoc",
+    "numpydoc",
+]
+
+source_suffix = [".rst", ".md"]
+master_doc = "index"
+
+html_theme = "alabaster"

docs/index.rst

@@ -0,0 +1,17 @@
+Welcome to momentGW's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. mdinclude::
+   ../README.md
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pyproject.toml

@@ -54,6 +54,9 @@ dev = [
     "pytest>=6.2.4",
     "pytest-cov>=4.0.0",
     "pytest-env>=1.1.0",
+    "sphinx>=4.0.0",
+    "sphinx-mdinclude>=0.5.0",
+    "numpydoc>=1.1.0",
 ]
 mpi = [
     "mpi4py>=3.1.0",