add RTD configuration (#70)

* add RTD configuration

* no-op commit to trigger RTD PR build

.github/workflows/ci.yml

@@ -129,20 +129,3 @@ jobs:
       - uses: codecov/codecov-action@v2
         with:
           file: ./coverage.xml
-  build-docs:
-    name: Build documentation and check warnings
-    needs: [ test ]
-    runs-on: ubuntu-latest
-    steps:
-      - run: sudo apt-get install graphviz texlive-latex-extra dvipng
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
-      - uses: actions/cache@v3
-        with:
-          path: ${{ env.pythonLocation }}
-          key: build-docs-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
-      - run: pip install ".[docs]"
-      - run: sphinx-build -W docs/source build/docs
-

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - htmlzip
+  - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

docs/source/conf.py

@@ -52,3 +52,8 @@ def setup(app):
 html_domain_indices = True
 html_sidebars = {"**": ["globaltoc.html", "relations.html", "searchbox.html"]}
 html_use_index = True
+
+# Enable nitpicky mode - which ensures that all references in the docs
+# resolve.
+nitpicky = True
+nitpick_ignore = []