Added .readthedocs.yaml file (#140)

skip-checks: true

.github/workflows/build.yml

@@ -12,6 +12,7 @@ on:
       - '.bumpversion.cfg'
       - '.flake8'
       - '.pre-commit-config.yaml'
+      - '.readthedocs.yaml'
       - '**.md'
       - '!README.md'
       - '.github/**'
@@ -28,6 +29,7 @@ on:
       - '.bumpversion.cfg'
       - '.flake8'
       - '.pre-commit-config.yaml'
+      - '.readthedocs.yaml'
       - '**.md'
       - '!README.md'
       - '.github/**'

.readthedocs.yaml

@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_create_environment:
+      - pip install pdm
+      - pdm config python.use_venv false
+      - pdm config check_update false
+    post_install:
+      - pdm sync --no-self --dev --group=doc
+    pre_build:
+      - python -m sphinx -b linkcheck -D docs/source/ $READTHEDOCS_OUTPUT/linkcheck
+
+sphinx:
+  configuration: docs/source/conf.py

docs/source/conf.py

@@ -52,7 +52,7 @@
 exclude_patterns = ["_include", "_extensions"]
 
 
-# -- sphinx.ext.autodoc configuration -------------------------------------------
+# -- sphinx.ext.autodoc configuration ----------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
 
 autoclass_content = "both"
@@ -92,7 +92,7 @@
 }
 
 
-# -- sphinx.ext.napoleon configuration -------------------------------------------
+# -- sphinx.ext.napoleon configuration ---------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
 
 napoleon_numpy_docstring = False
@@ -131,9 +131,14 @@
 html_theme = "sphinx_rtd_theme"
 html_static_path = []
 
-# -- sphinx-rtd-theme configuration -------------------------------------
+# -- sphinx-rtd-theme configuration ------------------------------------------
 # https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
 
 html_theme_options = {
     "navigation_depth": -1,  # Unlimited
 }
+
+# -- Options for the linkcheck builder ---------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
+
+linkcheck_timeout = 1

pyproject.toml

@@ -116,6 +116,7 @@ exclude = [
   ".github/",
   ".vscode/",
   ".bumpversion.cfg",
+  ".readthedocs.yaml",
 ]
 
 [tool.hatch.build.targets.wheel]