Skip to content

Commit bdc8154

Browse files
Bump sphinx+sphinx-rtd-theme, and properly install sphinx-rtd-theme (#1233)
* Bump sphinx-rtd-theme from 1.2.2 to 1.3.0 in /requirements Bumps [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) from 1.2.2 to 1.3.0. - [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst) - [Commits](readthedocs/sphinx_rtd_theme@1.2.2...1.3.0) --- updated-dependencies: - dependency-name: sphinx-rtd-theme dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Bump sphinx from 6.2.1 to 7.2.2 in /requirements Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 6.2.1 to 7.2.2. - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/master/CHANGES) - [Commits](sphinx-doc/sphinx@v6.2.1...v7.2.2) --- updated-dependencies: - dependency-name: sphinx dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * Set sphinx_rtd_theme as html_theme + extensions ...as per the installation instructions at https://sphinx-rtd-theme.readthedocs.io/en/1.3.0/installing.html. This should admittedly have been done in c3119b0, when originally adding `sphinx-rtd-theme` as a requirement. Lastly, it seems like the `html_theme` config setting was recently made required, since only today's builds fail (see e.g. https://readthedocs.org/projects/django-simple-history/builds/21687449/). --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Anders <[email protected]>
1 parent 78bcd0e commit bdc8154

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

docs/conf.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@
2525

2626
# Add any Sphinx extension module names here, as strings. They can be extensions
2727
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28-
extensions = ["sphinx.ext.autodoc"]
28+
extensions = [
29+
"sphinx.ext.autodoc",
30+
"sphinx_rtd_theme",
31+
]
2932

3033
# Add any paths that contain templates here, relative to this directory.
3134
templates_path = ["_templates"]
@@ -93,7 +96,7 @@
9396

9497
# The theme to use for HTML and HTML Help pages. See the documentation for
9598
# a list of builtin themes.
96-
# html_theme = 'default'
99+
html_theme = "sphinx_rtd_theme"
97100

98101
# Theme options are theme-specific and customize the look and feel of a theme
99102
# further. For a list of options available for each theme, see the

requirements/docs.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Install this project in editable mode, so that its package metadata can be queried
22
-e .
3-
Sphinx==6.2.1
4-
sphinx-rtd-theme==1.2.2
3+
Sphinx==7.2.2
4+
sphinx-rtd-theme==1.3.0

0 commit comments

Comments
 (0)