openstack
/
nova-specs
Code Issues Proposed changes

Avoid Sphinx 4.4.0 to fix specs doc build 

It seems Sphinx 4.4.0 made the _`[1]` type of references global. These
were document local references in the past. The nova spec repo has
multiple documents reusing such reference labels. So with 4.4.0 the doc
build fails with duplicate reference error.

This patch pins the Sphinx version to unblock the doc build job.

Change-Id: I3bb152d1c823b0e3f8a85f3f3f368a76bdfbe033
This commit is contained in:
Balazs Gibizer 2022-02-08 16:38:30 +01:00
parent 793dd029b6
commit 44ccb9898f
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/requirements.txt
View File

@ -1,7 +1,10 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx>=2.0.0,!=2.1.0 # BSD
# NOTE(gibi): Sphinx 4.4.0 made _`[1]` type of refs global
# and that breaks the spec builds
sphinx>=2.0.0,!=2.1.0,!=4.4.0 # BSD
sphinxcontrib-seqdiag>=0.8.4 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
yasfb>=0.8.0 # BSD