ceph/admin/doc-requirements.txt

Sphinx == 2.4.4
git+https://github.com/ceph/sphinx-ditaa.git@py3#egg=sphinx-ditaa
breathe == 4.14.2
pyyaml >= 5.1.2
Cython
prettytable
sphinx-autodoc-typehints == 1.10.3
typed-ast
admin/doc-requirements: pin sphinx-autodoc-typehints to 1.10.3 to silence following error: ERROR: sphinx-autodoc-typehints 1.11.0 has requirement Sphinx>=3.0, but you'll have sphinx 2.4.3 which is incompatible. * update breathe to the latest release, 4.14.2, which supports sphinx < 3.0 * pin sphinx to 2.4.4 the last sphinx before 3.0.0. as if sphinx >= 3.0 is used, we have errors like: Invalid C declaration: Expected identifier in nested name, got keyword: int [error at 18] CEPH_RADOS_API int rados_aio_append (rados_ioctx_t io, const char oid, rados_completion_t completion, const char buf, size_t len) ------------------^ Signed-off-by: Kefu Chai <kchai@redhat.com> 2020-06-22 00:28:37 +00:00			`Sphinx == 2.4.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: pin sphinx-autodoc-typehints to 1.10.3 to silence following error: ERROR: sphinx-autodoc-typehints 1.11.0 has requirement Sphinx>=3.0, but you'll have sphinx 2.4.3 which is incompatible. * update breathe to the latest release, 4.14.2, which supports sphinx < 3.0 * pin sphinx to 2.4.4 the last sphinx before 3.0.0. as if sphinx >= 3.0 is used, we have errors like: Invalid C declaration: Expected identifier in nested name, got keyword: int [error at 18] CEPH_RADOS_API int rados_aio_append (rados_ioctx_t io, const char oid, rados_completion_t completion, const char buf, size_t len) ------------------^ Signed-off-by: Kefu Chai <kchai@redhat.com> 2020-06-22 00:28:37 +00:00			`breathe == 4.14.2`
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: 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: pin sphinx-autodoc-typehints to 1.10.3 to silence following error: ERROR: sphinx-autodoc-typehints 1.11.0 has requirement Sphinx>=3.0, but you'll have sphinx 2.4.3 which is incompatible. * update breathe to the latest release, 4.14.2, which supports sphinx < 3.0 * pin sphinx to 2.4.4 the last sphinx before 3.0.0. as if sphinx >= 3.0 is used, we have errors like: Invalid C declaration: Expected identifier in nested name, got keyword: int [error at 18] CEPH_RADOS_API int rados_aio_append (rados_ioctx_t io, const char oid, rados_completion_t completion, const char buf, size_t len) ------------------^ Signed-off-by: Kefu Chai <kchai@redhat.com> 2020-06-22 00:28:37 +00:00			`sphinx-autodoc-typehints == 1.10.3`
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`