]> git-server-git.apps.pok.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>
Wed, 16 Sep 2020 17:32:34 +0000 (01:32 +0800)
commit52638b48bdb3a3b7a3aadf075aef6da6e3aa4503
treee2a071afe06d7790ca76983de704b04a97739ff1
parent6734b0b976911750c329f34348a595cd3a6ddc82
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)
36 files changed:
.readthedocs.yml
admin/doc-read-the-docs.txt [new file with mode: 0644]
doc/architecture.rst
doc/cephfs/cephfs-io-path.rst
doc/conf.py
doc/dev/deduplication.rst
doc/dev/msgr2.rst
doc/install/ceph-deploy/quick-ceph-deploy.rst
doc/install/ceph-deploy/quick-cephfs.rst
doc/install/ceph-deploy/quick-common.rst
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/radosgw/vault.rst
doc/rbd/index.rst
doc/rbd/libvirt.rst
doc/rbd/qemu-rbd.rst
doc/rbd/rbd-cloudstack.rst
doc/rbd/rbd-kubernetes.rst
doc/rbd/rbd-live-migration.rst
doc/rbd/rbd-openstack.rst
doc/rbd/rbd-persistent-cache.rst
doc/rbd/rbd-snapshot.rst
doc/start/intro.rst
doc/start/quick-rbd.rst