ceph/.readthedocs.yml

---
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2
formats: []
build:
  os: ubuntu-22.04
  tools:
    python: "3.8"
  apt_packages:
    - ditaa
    - graphviz
python:
  install:
    - requirements: admin/doc-requirements.txt
    - requirements: admin/doc-read-the-docs.txt
    - requirements: admin/doc-pybind.txt
sphinx:
  builder: dirhtml
  configuration: doc/conf.py
readthedocs: add .readthedocs.yml Signed-off-by: Kefu Chai <kchai@redhat.com> 2020-04-09 07:35:15 +00:00			`---`
			`# Read the Docs configuration file`
			`# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details`

			`version: 2`
			`formats: []`
			`build:`
.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-06-30 19:37:58 +00:00			`os: ubuntu-22.04`
			`tools:`
			`python: "3.8"`
.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-01 16:37:19 +00:00			`apt_packages:`
			`- ditaa`
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 19:50:47 +00:00			`- graphviz`
readthedocs: add .readthedocs.yml Signed-off-by: Kefu Chai <kchai@redhat.com> 2020-04-09 07:35:15 +00:00			`python:`
			`install:`
			`- requirements: admin/doc-requirements.txt`
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-09 13:25:39 +00:00			`- requirements: admin/doc-read-the-docs.txt`
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 07:09:49 +00:00			`- requirements: admin/doc-pybind.txt`
readthedocs: add .readthedocs.yml Signed-off-by: Kefu Chai <kchai@redhat.com> 2020-04-09 07:35:15 +00:00			`sphinx:`
			`builder: dirhtml`
			`configuration: doc/conf.py`