Commit Graph

8 Commits

Author SHA1 Message Date
Patrick Donnelly
d882255dd1
doc: remove rtd main checkout
This is partial revert of 055fe1f825.

We don't need to checkout main anymore. A followup commit will make HTTP
redirects possible via ReadTheDocs.

This commit does not exist in main. It will be forward ported once the
release branches appropriately redirect /en/$release/releases to
/en/latest/releases.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
(cherry picked from commit 1f056ea5d4)
2022-11-28 08:37:24 -05:00
David Galloway
7e25c03697 doc: Install graphviz
Fixes `WARNING: dot command 'dot' cannot be run (needed for graphviz output), check the graphviz_dot setting`

Signed-off-by: David Galloway <dgallowa@redhat.com>
2022-08-08 16:14:38 -04:00
David Galloway
055fe1f825 .readthedocs.yml: Always build latest doc/releases pages
We don't backport PRs merged into doc/releases.  Therefore, when one browses to an older Ceph release version on docs.ceph.com (e.g., https://docs.ceph.com/en/pacific/), the information is out of date at best.

The doc/releases page is only accurate if browsing https://docs.ceph.com/en/latest/, for example.

So this post_checkout command will make sure we've checked out doc/releases from main before building and publishing.

Signed-off-by: David Galloway <dgallowa@redhat.com>
2022-07-20 12:14:32 -04:00
Kefu Chai
57f57c9419 .readthedocs.yml: use ditaa instead of plantweb
use ditaa to reader ditaa images instead of relying plantweb service.
more stable this way.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-08-02 01:00:35 +08:00
Kefu Chai
0bde0f3a38 .readthedocs.yml: use python3.8
to prepare the python3.8 migration

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-08-02 00:41:34 +08:00
Kefu Chai
6fb4aff5ad admin/build-doc: consolidate the build deps into admin/doc-pybind.txt
since all the python bindings are required for building the doc, extract
them into admin/doc-pybind.txt.

because the pybind python extensions require Cython python module to build,
we have to move them  into another requirement file, and install them after
Cython is installed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-12 16:27:20 +08:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
Kefu Chai
99b75c14d2 readthedocs: add .readthedocs.yml
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-09 15:35:45 +08:00