Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Avoid Sphinx 5.2.0.post0 for docsite builds to work around a sphinx-rtd-theme bug #40

Merged
merged 1 commit into from
Sep 25, 2022
Merged

Avoid Sphinx 5.2.0.post0 for docsite builds to work around a sphinx-rtd-theme bug #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelogs/fragments/40-sphinx-init-restriction.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
bugfixes:
- "The ``sphinx-init`` subcommand's ``requirement.txt`` file avoids Sphinx 5.2.0.post0, which triggers a bug in sphinx-rtd-theme
which happens to be the parent theme of the default theme sphinx_ansible_theme used by ``sphinx-init``
(https://github.com/ansible-community/antsibull-docs/issues/39, https://github.com/ansible-community/antsibull-docs/pull/40)."
2 changes: 1 addition & 1 deletion src/antsibull_docs/data/sphinx_init/requirements_txt.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@

antsibull-docs >= 1.0.0, < 2.0.0
ansible-pygments
sphinx
sphinx != 5.2.0.post0 # The != 5.2.0.post0 restriction is thanks due to a bug in the sphinx-rtd-theme. Once this is fixed, this restriction can be removed.
@{ sphinx_theme_package }@