]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
admin/doc-requirements.txt: pin Sphinx at 3.5.4
authorKefu Chai <tchaikov@gmail.com>
Sat, 30 Oct 2021 03:18:17 +0000 (11:18 +0800)
committerKefu Chai <kchai@redhat.com>
Mon, 1 Nov 2021 16:08:39 +0000 (00:08 +0800)
* pin Sphinx at 3.5.4
* pin docutils at 0.18

at least the combination of these two versions
is known to compile.

to address the bug reported at
https://sourceforge.net/p/docutils/bugs/431/

the backtrace looks like:

/home/jenkins-build/build/workspace/ceph-pr-docs/build-doc/virtualenv/lib/python3.8/site-packages/sphinx/util/docutils.py:285:
RemovedInSphinx30Warning: function based directive support is now
deprecated. Use class based directive instead.
  warnings.warn('function based directive support is now deprecated. '

Exception occurred:
  File
"/home/jenkins-build/build/workspace/ceph-pr-docs/build-doc/virtualenv/lib/python3.8/site-packages/docutils/writers/html5_polyglot/__init__.py",
line 445, in section_title_tags
    if (ids and self.settings.section_self_link
AttributeError: 'Values' object has no attribute 'section_self_link'

please note this change is not cherry-picked from
master, because master already bumped Sphinx to 3.5.4
in 4968baa2523bd2a5ca6be147b26bc28906a864c9.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
(cherry picked from commit 6362b554e2e57227c9fda51c7703f14674da8358)

Conflicts:
admin/doc-requirements.txt: trivial resolution

admin/doc-requirements.txt

index 0a0810bfe9a21b413913618d31a8598ee558fbad..65efd49906ee1e5232301cc0c35e4781181dcb6a 100644 (file)
@@ -1,4 +1,4 @@
-Sphinx == 2.4.3
+Sphinx == 3.5.4
 git+https://github.com/ceph/sphinx-ditaa.git@py3#egg=sphinx-ditaa
 breathe >= 4.20.0
 pyyaml >= 5.1.2