]> git.apps.os.sepia.ceph.com Git - ceph.git/commit
doc: use plantweb as fallback of sphinx-ditaa
authorKefu Chai <kchai@redhat.com>
Thu, 9 Apr 2020 13:25:39 +0000 (21:25 +0800)
committerKefu Chai <kchai@redhat.com>
Thu, 26 Nov 2020 09:33:30 +0000 (17:33 +0800)
commit3a00a854b5444f225c404e5bc476e9920861eecd
tree7a4e2845c3587c2e3bbd2673453ac4b78cfcc7b5
parent574a97733eff3ddf9e597e494b6ffa810091f6e6
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>
(cherry picked from commit 0cb56e0f13dc57167271ec7f20f11421416196a2)
28 files changed:
.readthedocs.yml
admin/doc-read-the-docs.txt [new file with mode: 0644]
doc/architecture.rst
doc/conf.py
doc/install/install-vm-cloud.rst
doc/install/manual-deployment.rst
doc/install/manual-freebsd-deployment.rst
doc/rados/api/librados-intro.rst
doc/rados/configuration/mon-config-ref.rst
doc/rados/configuration/mon-osd-interaction.rst
doc/rados/configuration/network-config-ref.rst
doc/rados/operations/cache-tiering.rst
doc/rados/operations/monitoring-osd-pg.rst
doc/rados/operations/placement-groups.rst
doc/rados/operations/user-management.rst
doc/radosgw/admin.rst
doc/radosgw/index.rst
doc/radosgw/swift/tutorial.rst
doc/rbd/index.rst
doc/rbd/libvirt.rst
doc/rbd/qemu-rbd.rst
doc/rbd/rbd-cloudstack.rst
doc/rbd/rbd-openstack.rst
doc/rbd/rbd-snapshot.rst
doc/start/intro.rst
doc/start/quick-ceph-deploy.rst
doc/start/quick-common.rst
doc/start/quick-rbd.rst