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

jewel: admin: bump sphinx to 1.6 #18166

Merged
merged 4 commits into from Oct 9, 2017
Merged

jewel: admin: bump sphinx to 1.6 #18166

merged 4 commits into from Oct 9, 2017

Conversation

tchaikov
Copy link
Contributor

@tchaikov tchaikov commented Oct 8, 2017 •
edited

@tchaikov
admin: bump sphinx to 1.6
2012426 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
(cherry picked from commit 88a1114)
@tchaikov
Copy link
Contributor Author

tchaikov commented Oct 8, 2017

this should address following error while building doc

Running Sphinx v1.1.3

Exception occurred:
  File "/home/jenkins-build/build/workspace/ceph-pr-docs/build-doc/virtualenv/src/breathe/breathe/renderer/sphinxrenderer.py", line 25, in DomainDirectiveFactory
    'enumvalue': (cpp.CPPEnumeratorObject, 'enumerator'),
AttributeError: 'module' object has no attribute 'CPPEnumeratorObject'

because breathe introduced a change not compatible with old sphinx: breathe-doc/breathe@41990f9

which requires sphinx v1.3.1 and up. so backport the change bumping up the sphinx version.

@tchaikov tchaikov changed the title admin: bump sphinx to 1.6 jewel: admin: bump sphinx to 1.6 Oct 8, 2017
@tchaikov
doc: switch to upstream sphinx-ditaa
dcb703d 
it works with setuptools and is now compatible with py3

the py3 branch is created to track the upstream's master branch

Signed-off-by: Kefu Chai <kchai@redhat.com>
(cherry picked from commit fda079d)
@tchaikov
doc,cmake: do not scan non-man pages when building man pages
9e1735a 
Signed-off-by: Kefu Chai <kchai@redhat.com>
(cherry picked from commit 0e00d2f)

Conflicts:
	doc/man/CMakeLists.txt: jewel does not have this file. so do
not cherry-pick changes of it.
@tchaikov
admin/build-doc: support optional argument for specifying sphinx buil…
b606427 
…ders

Signed-off-by: Kefu Chai <kchai@redhat.com>
(cherry picked from commit 5b9ec53)

Conflicts:
	admin/build-doc: trivial resolution
@tchaikov
Copy link
Contributor Author

tchaikov commented Oct 8, 2017

changelog

  • old sphinx-ditaa extension is not compatible with the new sphinx, so update it as well
  • need to pass "tag" to sphinx-build, otherwise the ditaa is not available to sphinx manpage builder. hence sphinx will fail with the exception of NotImplementedError: Unknown node: ditaa
  • need to check tags in sphinx's setting file of conf.py

@alfredodeza alfredodeza merged commit 8a33d8c into ceph:jewel Oct 9, 2017
@tchaikov tchaikov deleted the wip-jewel-sphinx branch October 9, 2017 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alfredodeza alfredodeza alfredodeza approved these changes

@smithfarm smithfarm Awaiting requested review from smithfarm

Assignees
No one assigned
Labels
bug-fix documentation
Projects
None yet
Milestone
No milestone
3 participants
@tchaikov @alfredodeza @smithfarm