Merge pull request #733 from glatterf42/fix/docs

Adapt to new RTD configuration style

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build PDF & ePub
+formats:
+  - epub
+  - pdf
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+python:
+  install:
+  - requirements: doc/requirements.txt
+  - requirements: ci/rtd-requirements.txt
+  - method: pip
+    path: .
+    extra_requirements:
+      - docs

doc/requirements.in

@@ -0,0 +1,8 @@
+# Input file for pip-compile 
+# Only specify the packages necessary for [docs]
+
+gitpython==3.1.32
+numpydoc==1.5.0
+sphinx==6.2.1
+sphinx-rtd-theme==1.2.2
+sphinxcontrib-bibtex==2.5.0

doc/requirements.txt

@@ -0,0 +1,87 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile --allow-unsafe --config=pyproject.toml --output-file=doc/requirements.txt doc/requirements.in
+#
+alabaster==0.7.13
+    # via sphinx
+babel==2.12.1
+    # via sphinx
+certifi==2023.7.22
+    # via requests
+charset-normalizer==3.2.0
+    # via requests
+docutils==0.18.1
+    # via
+    #   pybtex-docutils
+    #   sphinx
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-bibtex
+gitdb==4.0.10
+    # via gitpython
+gitpython==3.1.32
+    # via -r doc/requirements.in
+idna==3.4
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+jinja2==3.1.2
+    # via
+    #   numpydoc
+    #   sphinx
+latexcodec==2.0.1
+    # via pybtex
+markupsafe==2.1.3
+    # via jinja2
+numpydoc==1.5.0
+    # via -r doc/requirements.in
+packaging==23.1
+    # via sphinx
+pybtex==0.24.0
+    # via
+    #   pybtex-docutils
+    #   sphinxcontrib-bibtex
+pybtex-docutils==1.0.2
+    # via sphinxcontrib-bibtex
+pygments==2.16.1
+    # via sphinx
+pyyaml==6.0.1
+    # via pybtex
+requests==2.31.0
+    # via sphinx
+six==1.16.0
+    # via
+    #   latexcodec
+    #   pybtex
+smmap==5.0.0
+    # via gitdb
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==6.2.1
+    # via
+    #   -r doc/requirements.in
+    #   numpydoc
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-bibtex
+    #   sphinxcontrib-jquery
+sphinx-rtd-theme==1.2.2
+    # via -r doc/requirements.in
+sphinxcontrib-applehelp==1.0.4
+    # via sphinx
+sphinxcontrib-bibtex==2.5.0
+    # via -r doc/requirements.in
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.1
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+urllib3==2.0.4
+    # via requests