mirror of
https://github.com/ceph/ceph
synced 2024-12-28 22:43:29 +00:00
055fe1f825
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>
28 lines
695 B
YAML
28 lines
695 B
YAML
---
|
|
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
#
|
|
# The pre_build command checks if we're building a named branch (i.e., not a PR).
|
|
# If so, check out doc/releases from the main branch before building so
|
|
# it's always up to date on docs.ceph.com/en/*.
|
|
|
|
version: 2
|
|
formats: []
|
|
build:
|
|
os: ubuntu-22.04
|
|
tools:
|
|
python: "3.8"
|
|
apt_packages:
|
|
- ditaa
|
|
jobs:
|
|
pre_build:
|
|
- bash admin/rtd-checkout-main
|
|
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
|