Merge pull request #113 from cdriehuys/rtd-fix

docs: Update Read the Docs configuration
cdriehuys · Mar 25, 2023 · e6e334d · e6e334d
2 parents 681ffe1 + f1516af
commit e6e334d
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 29 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+
+  tools:
+    python: "3.11"
+
+  jobs:
+    post_create_environment:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+
+    post_install:
+      - poetry install --with docs
+
+sphinx:
+  configuration: docs/conf.py
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -0,0 +1 @@
+# Changelog
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,7 +16,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["myst_parser", "sphinxcontrib.httpdomain", "sphinx_issues"]
+extensions = ["myst_parser", "sphinxcontrib.httpdomain"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -61,10 +61,6 @@
 todo_include_todos = False
 
 
-# Configuration for 'sphinx-issues'
-issues_github_path = "cdriehuys/django-rest-email-auth"
-
-
 # -- Options for HTML output -------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -50,9 +50,14 @@ optional = true
 [tool.poetry.group.docs.dependencies]
 myst-parser = "^1.0.0"
 sphinx = "^5"
-sphinx-autobuild = "2020.9.1"
-sphinx-issues = "1.2.0"
-sphinx-rtd-theme = "1.2.0"
+sphinx-rtd-theme = "^1.2.0"
+sphinxcontrib-httpdomain = "^1.8.1"
+
+[tool.poetry.group.docs-dev]
+optional = true
+
+[tool.poetry.group.docs-dev.dependencies]
+sphinx-autobuild = "^2020.9.1"
 
 [build-system]
 requires = ["poetry-core"]