ceph/admin/doc-requirements.txt

Sphinx == 3.2.1
git+https://github.com/ceph/sphinx-ditaa.git@py3#egg=sphinx-ditaa
breathe
pyyaml >= 5.1.2
Cython
prettytable
sphinx-autodoc-typehints
sphinx-prompt
Sphinx-Substitution-Extensions
typed-ast
sphinxcontrib-openapi
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 == 3.2.1`
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: 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			`breathe`
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: 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`
			`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`