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.
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
admin/doc-requirements: bump sphinx to 4.4.0 #45266
Conversation
jenkins test docs |
retest this please. |
bump sphinx to latest stable. to address following build failure ERROR: sphinx-autodoc-typehints 1.17.0 has requirement Sphinx>=4, but you'll have sphinx 3.5.4 which is incompatible. ERROR: sphinx-substitution-extensions 2022.2.16 has requirement sphinx>=4.0.0, but you'll have sphinx 3.5.4 which is incompatible. also bump bump sphinx-rtd-theme, otherwise we'd have following build failure: ERROR: sphinx-rtd-theme 0.5.2 has requirement docutils<0.17, but you'll have docutils 0.17.1 which is incompatible. Signed-off-by: Kefu Chai <tchaikov@gmail.com>
jenkins test docs |
jenkins test docs |
this allows the "rpc"ized methods of OrchestratorClientMixin to have the docstring defined by the original methods. Signed-off-by: Kefu Chai <tchaikov@gmail.com>
this helps to silence the warning from sphinx, like src/pybind/mgr/orchestrator/_interface.py:docstring of orchestrator._interface.Orchestrator.remove_osds:9: WARNING: Field list ends without a blank line; unexpected unindent. Signed-off-by: Kefu Chai <tchaikov@gmail.com>
breathe calls doxygen for extracting/generating docs from code. while doxygen complains at seeing undocumented fields/func. these warnings could fail the sphinx-build command, if it takes warnings as errors. in this change, these warnings are silenced. Signed-off-by: Kefu Chai <tchaikov@gmail.com>
@ljflores hi Laura, thanks for your review and approval. but it seems sphinx 4.x is more picky, and it considers the warnings as errors and hence fails the @sebastian-philipp hi Sebastian, could you please help review the orchestrator related change? the goal is to silence the new warnings from Sphinx 4.4.0. like
|
regarding the change in the docstring of shim'ed methods, please see the difference between |
so it can be rendered by sphinx in a better way. Signed-off-by: Kefu Chai <tchaikov@gmail.com>
add an empty line before a doctest block would help sphinx to tell where the session starts. see also https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#doctest-blocks Signed-off-by: Kefu Chai <tchaikov@gmail.com>
otherwise sphinx takes "Typical use" and the following line as a field. see also https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#field-lists Signed-off-by: Kefu Chai <tchaikov@gmail.com>
jenkins test api |
bump sphinx to latest stable. to address following build failure
ERROR: sphinx-autodoc-typehints 1.17.0 has requirement Sphinx>=4, but you'll have sphinx 3.5.4 which is incompatible.
ERROR: sphinx-substitution-extensions 2022.2.16 has requirement sphinx>=4.0.0, but you'll have sphinx 3.5.4 which is incompatible.
also bump bump sphinx-rtd-theme
otherwise we'd have
ERROR: sphinx-rtd-theme 0.5.2 has requirement docutils<0.17, but you'll have docutils 0.17.1 which is incompatible.
Signed-off-by: Kefu Chai tchaikov@gmail.com
Checklist
Show available Jenkins commands
jenkins retest this please
jenkins test classic perf
jenkins test crimson perf
jenkins test signed
jenkins test make check
jenkins test make check arm64
jenkins test submodules
jenkins test dashboard
jenkins test dashboard cephadm
jenkins test api
jenkins test docs
jenkins render docs
jenkins test ceph-volume all
jenkins test ceph-volume tox
jenkins test windows