Avoid Sphinx 5.2.0.post0 for docsite builds to work around a sphinx-r…

…td-theme bug. (#40)
ansible-community · Sep 25, 2022 · 7bb8609 · 7bb8609
1 parent 2b567e1
commit 7bb8609
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/changelogs/fragments/40-sphinx-init-restriction.yml b/changelogs/fragments/40-sphinx-init-restriction.yml
@@ -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)."
diff --git a/src/antsibull_docs/data/sphinx_init/requirements_txt.j2 b/src/antsibull_docs/data/sphinx_init/requirements_txt.j2
@@ -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 }@