Skip to content

Commit

Permalink
🐛 Fix documentation build
Browse files Browse the repository at this point in the history
PR #298
  • Loading branch information
jambonrose committed Aug 6, 2024
1 parent 476356c commit 9ff56a7
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 12 deletions.
16 changes: 16 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
# https://docs.readthedocs.io/en/stable/config-file/v2.html
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.12"
sphinx:
configuration: docs/conf.py
formats:
- pdf
- epub
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: doc-requirements.txt
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ exclude .ignore
exclude .pre-commit-config.yaml
exclude .prettierignore
exclude .prettierrc.toml
exclude .readthedocs.yaml
exclude codecov.yml
exclude Makefile
include .bumpversion.cfg
Expand Down
12 changes: 6 additions & 6 deletions doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Django>=3.2,<3.3
factory-boy==3.2.1
Faker==11.3.0
Pygments==2.11.2
python-dateutil==2.8.2
Sphinx==4.3.2
sphinx-rtd-theme==1.0.0
factory-boy==3.3.0
Faker==26.1.0
Pygments==2.18.0
python-dateutil==2.9.0.post0
Sphinx==7.4.7
sphinx-rtd-theme==2.0.0
6 changes: 1 addition & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,6 @@ def setup(app):

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
Expand Down Expand Up @@ -181,7 +177,7 @@ def setup(app):
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ envlist =
; py39-django32-lint,
; py39-django32-pylint,
py39-django32-pkgcheck,
py37-docs,
py312-docs,
py{36,37,38,39}-django{22,30,31,32}-unit,
py39-django{22,32}-{extension,replacement}
py39-django{22}-{integration}
Expand Down

0 comments on commit 9ff56a7

Please sign in to comment.