RepoMirrors
/
ceph
mirror of https://github.com/ceph/ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ceph/admin/doc-requirements.txt

19 lines
386 B
Plaintext
Raw Normal View History

admin/doc-requirements.txt: pin sphinx and sphinx_rtd_theme to a certain version to ensure that we can have reproducible builds Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-14 15:24:36 +00:00
Sphinx == 3.5.4
doc: install build-doc deps without git clone With `-e` the repository is cloned, leading to `git clean` skipping the cloned dependencies due to the `.git` directory, and forcing manual removal. [nwatkins@daq ceph]$ git clean -dxf Skipping repository build-doc/virtualenv/src/breathe Skipping repository build-doc/virtualenv/src/sphinx-ditaa Signed-off-by: Noah Watkins <nwatkins@redhat.com>
2018-10-03 22:48:10 +00:00
git+https://github.com/ceph/sphinx-ditaa.git@py3#egg=sphinx-ditaa
admin/doc-requirements: use funcparserlib from github funcparserlib is pulled in as a dependency by blockdiag. the latest version of funcparserlib available on pypi is v0.3.6 which is not compatible with Python3.8. in this change, funcparserlib is installed from github instead to address the build failure like: File "/home/docs/checkouts/readthedocs.org/user_builds/ceph/envs/41855/lib/python3.8/site-packages/sphinxcontrib/seqdiag.py", line 26, in <module> import seqdiag.utils.rst.nodes File "/home/docs/checkouts/readthedocs.org/user_builds/ceph/envs/41855/lib/python3.8/site-packages/seqdiag/utils/rst/nodes.py", line 16, in <module> from blockdiag.utils.rst import nodes File "/home/docs/checkouts/readthedocs.org/user_builds/ceph/envs/41855/lib/python3.8/site-packages/blockdiag/utils/rst/nodes.py", line 21, in <module> import blockdiag.builder File "/home/docs/checkouts/readthedocs.org/user_builds/ceph/envs/41855/lib/python3.8/site-packages/blockdiag/builder.py", line 16, in <module> from blockdiag import parser File "/home/docs/checkouts/readthedocs.org/user_builds/ceph/envs/41855/lib/python3.8/site-packages/blockdiag/parser.py", line 43, in <module> from funcparserlib.parser import (a, finished, forward_decl, many, maybe, skip, File "/home/docs/checkouts/readthedocs.org/user_builds/ceph/envs/41855/lib/python3.8/site-packages/funcparserlib/parser.py", line 123 except NoParseError, e: ^ SyntaxError: invalid syntax once https://github.com/vlasovskikh/funcparserlib/issues/65 is addressed, we should drop this change. Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2021-09-06 14:30:02 +00:00
git+https://github.com/vlasovskikh/funcparserlib.git
admin/doc-requirements.txt: Not breathe=4.33 See https://github.com/michaeljones/breathe/issues/803 Signed-off-by: David Galloway <dgallowa@redhat.com>
2022-02-14 20:11:58 +00:00
breathe >= 4.20.0,!=4.33
mgr/cephadm: make agent certs compatible with OpenSSL hostname and ip checks Signed-off-by: Adam King <adking@redhat.com>
2021-09-09 17:36:40 +00:00
cryptography
doc: build mon_command_api.rst using a homebrew extension so we can build the command doc using ReadTheDoc infra, without adding the generated rst file to the source repo. before this change, all the commands are ordered alphabetically. after this change, command docs are generated by two directives, and are ordered separately. we could restructure the directives and merge them. but let's leave it for a future change if this is important. for more details on writing sphinx directives, see https://www.sphinx-doc.org/en/master/extdev/markupapi.html and https://docutils.sourceforge.io/docs/howto/rst-directives.html Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-07 15:43:26 +00:00
Jinja2
admin/build-doc: use python3 to address https://github.com/sphinx-doc/sphinx/issues/3620, we need to use sphinx with its fix at https://github.com/sphinx-doc/sphinx/commit/e049f86b2de1cfdf8a74c88dc9593d047c85d5cb in other words, we need to use sphinx v2.0.0 and up. but sphinx 2.0 requires python >= 3.5, so we have to use python3 for building the documents. in this change: * doc-requirements.txt: install python3 packages on debian derivatives * build-doc: install python3.6 packages from EPEL7, and use python3 venv for using sphinx2 * doc-requirements.txt: bump up all python packages to latest stable. Signed-off-by: Kefu Chai <kchai@redhat.com>
2019-08-07 09:46:13 +00:00
pyyaml >= 5.1.2
admin/build-doc: do not use system site-packages Don't use site-packages, since the host might have the same version, and it won't have the ditaa and breathe. Require Cython to make the venv sufficient. Signed-off-by: Sage Weil <sage@redhat.com>
2019-12-16 23:21:30 +00:00
Cython
doc: build mon_command_api.rst using a homebrew extension so we can build the command doc using ReadTheDoc infra, without adding the generated rst file to the source repo. before this change, all the commands are ordered alphabetically. after this change, command docs are generated by two directives, and are ordered separately. we could restructure the directives and merge them. but let's leave it for a future change if this is important. for more details on writing sphinx directives, see https://www.sphinx-doc.org/en/master/extdev/markupapi.html and https://docutils.sourceforge.io/docs/howto/rst-directives.html Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-07 15:43:26 +00:00
pcpp
doc: add prettytable to admin/doc-requirements.txt Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-01-24 13:15:44 +00:00
prettytable
admin/doc-requirements: bump up sphinx to 3.2.1 * use the latest stable sphinx * unpin breathe, sphinx-autodoc-typehints, so pip can choose the compatible versions without worrying about the compile failures. Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-28 10:24:32 +00:00
sphinx-autodoc-typehints
doc: replace luminous with |stable-release| "luminous" is a magic number in these contexts, and we should use a constant for representing it. the "sphinx_substitution_extensions" sphinx extension is introduced for performing the global subsitution. Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-28 10:26:26 +00:00
sphinx-prompt
admin/doc-requirements.txt: pin sphinx and sphinx_rtd_theme to a certain version to ensure that we can have reproducible builds Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-14 15:24:36 +00:00
sphinx_rtd_theme == 0.5.2
doc: replace luminous with |stable-release| "luminous" is a magic number in these contexts, and we should use a constant for representing it. the "sphinx_substitution_extensions" sphinx extension is introduced for performing the global subsitution. Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-28 10:26:26 +00:00
Sphinx-Substitution-Extensions
doc: Add sphinx_autodoc_typehints extension `mgr/orchestrator_modules.rst` makes heavy use type hints. Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-02-27 12:16:00 +00:00
typed-ast
mgr/dashboard/api: generate offline API docs Generate Sphinx documentation from OpenAPI YAML spec: - Fixed Docs controller doc generation - Now dashboard Python doesn't fails if dashboard/frontend/dist doesn't exist - OpenAPI added to @ceph/api CODEOWNERS - Renamed Ceph-Dashboard API to Ceph REST or RESTful API. - OpenAPI Docs: fixed decorators and docstrings. - Sphinx Docs: updated dashboard and dev ones. Co-authored-by: Ernesto Puerta <epuertat@redhat.com> Fixes: https://tracker.ceph.com/issues/45863 Signed-off-by: Courtney Caldwell <ccaldwel@redhat.com> Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2020-09-08 15:06:33 +00:00
sphinxcontrib-openapi
admin, doc: introduce sphinxcontrib.seqdiag for rendering sequence-diagram. unlike ditaa, seqdiag allows us to create sequence-diagram without worrying about the layout. and the syntax is quite like that of dot. Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-08-02 11:00:35 +00:00
sphinxcontrib-seqdiag
doc: Use older mistune https://github.com/miyakogi/m2r/issues/66 Signed-off-by: David Galloway <dgallowa@redhat.com>
2021-12-06 15:32:56 +00:00
mistune < 2.0.0