summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles-Henri de Boysson <ceache@users.noreply.github.com>2023-02-18 19:48:54 -0500
committerGitHub <noreply@github.com>2023-02-18 19:48:54 -0500
commit33c348bec621694c309deb5e6666ac3a40d64878 (patch)
tree196b7d80b5de50bb21e30f9f05122c9ed80bbb50
parent5225b3e2fab6fec3b12b789e3cc6f3218429d32d (diff)
parente24e1200351bac10c0fb9f23608bc385b35afb49 (diff)
downloadkazoo-33c348bec621694c309deb5e6666ac3a40d64878.tar.gz
Merge pull request #710 from ceache/feat/docs
chore(core): Fix documentation build
-rw-r--r--.readthedocs.yaml32
-rw-r--r--constraints.txt6
-rw-r--r--docs/conf.py1
-rw-r--r--setup.cfg1
4 files changed, 34 insertions, 6 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..95420fe
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.7"
+ # You can also specify other tool versions:
+ # nodejs: "19"
+ # rust: "1.64"
+ # golang: "1.19"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+ configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats: []
+# - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+ install:
+ - method: pip
+ path: .
+ extra_requirements:
+ - docs
diff --git a/constraints.txt b/constraints.txt
index dfc5457..42c8b14 100644
--- a/constraints.txt
+++ b/constraints.txt
@@ -5,9 +5,3 @@ flake8==5.0.2
objgraph==3.5.0
pytest==6.2.5
pytest-cov==3.0.0
-
-# Documentation building.
-Jinja2==2.7.3
-Pygments==1.6
-Sphinx==1.2.2
-docutils==0.12
diff --git a/docs/conf.py b/docs/conf.py
index fb1d598..17b3ff4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -42,6 +42,7 @@ extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx.ext.viewcode",
+ "sphinx_autodoc_typehints",
]
# Add any paths that contain templates here, relative to this directory.
diff --git a/setup.cfg b/setup.cfg
index 2f29292..63d3ac6 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -71,6 +71,7 @@ sasl =
docs =
Sphinx>=1.2.2
+ sphinx-autodoc-typehints>=1
typing =
mypy>=0.991