summaryrefslogtreecommitdiffstats
path: root/admin/doc-read-the-docs.txt (follow)
Commit message (Collapse)AuthorAgeFilesLines
* ceph/admin: s/master/mainZac Dover2022-03-181-1/+1
| | | | | | | | This PR changes the name "master" to "main" so that builds (and, I assume, a great many other things) will not fail. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* admin/build-doc: consolidate the build deps into admin/doc-pybind.txtKefu Chai2020-12-121-5/+0
| | | | | | | | | | | 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>
* doc: build api docs with Read the DocsKefu Chai2020-12-051-0/+5
| | | | | | | since we are able to build the python bindings using the stub implementation of C binding, let's enable the API docs build. Signed-off-by: Kefu Chai <kchai@redhat.com>
* doc: add in-doc search from read the docsKefu Chai2020-04-101-0/+1
| | | | | | | readthedocs-sphinx-search features better user experience than the builtin search offered by sphinx Signed-off-by: Kefu Chai <kchai@redhat.com>
* doc: use plantweb as fallback of sphinx-ditaaKefu Chai2020-04-101-0/+1
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>