Skip to content

Commit 9ff56a7

Browse files
authored
🐛 Fix documentation build
PR #298
1 parent 476356c commit 9ff56a7

File tree

5 files changed

+25
-12
lines changed

5 files changed

+25
-12
lines changed

.readthedocs.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
# https://docs.readthedocs.io/en/stable/config-file/v2.html
3+
version: 2
4+
build:
5+
os: ubuntu-22.04
6+
tools:
7+
python: "3.12"
8+
sphinx:
9+
configuration: docs/conf.py
10+
formats:
11+
- pdf
12+
- epub
13+
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
14+
python:
15+
install:
16+
- requirements: doc-requirements.txt

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ exclude .ignore
33
exclude .pre-commit-config.yaml
44
exclude .prettierignore
55
exclude .prettierrc.toml
6+
exclude .readthedocs.yaml
67
exclude codecov.yml
78
exclude Makefile
89
include .bumpversion.cfg

doc-requirements.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Django>=3.2,<3.3
2-
factory-boy==3.2.1
3-
Faker==11.3.0
4-
Pygments==2.11.2
5-
python-dateutil==2.8.2
6-
Sphinx==4.3.2
7-
sphinx-rtd-theme==1.0.0
2+
factory-boy==3.3.0
3+
Faker==26.1.0
4+
Pygments==2.18.0
5+
python-dateutil==2.9.0.post0
6+
Sphinx==7.4.7
7+
sphinx-rtd-theme==2.0.0

docs/conf.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,6 @@ def setup(app):
130130

131131
# -- General configuration ------------------------------------------------
132132

133-
# If your documentation needs a minimal Sphinx version, state it here.
134-
#
135-
# needs_sphinx = '1.0'
136-
137133
# Add any Sphinx extension module names here, as strings. They can be
138134
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
139135
# ones.
@@ -181,7 +177,7 @@ def setup(app):
181177
#
182178
# This is also used if you do content translation via gettext catalogs.
183179
# Usually you set "language" from the command line for these cases.
184-
language = None
180+
language = "en"
185181

186182
# List of patterns, relative to source directory, that match files and
187183
# directories to ignore when looking for source files.

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ envlist =
44
; py39-django32-lint,
55
; py39-django32-pylint,
66
py39-django32-pkgcheck,
7-
py37-docs,
7+
py312-docs,
88
py{36,37,38,39}-django{22,30,31,32}-unit,
99
py39-django{22,32}-{extension,replacement}
1010
py39-django{22}-{integration}

0 commit comments

Comments
 (0)