mirror of
https://github.com/ceph/ceph
synced 2025-01-02 17:12:31 +00:00
.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>
This commit is contained in:
parent
3ddd517362
commit
055fe1f825
@ -1,15 +1,23 @@
|
|||||||
---
|
---
|
||||||
# Read the Docs configuration file
|
# Read the Docs configuration file
|
||||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
# 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
|
version: 2
|
||||||
formats: []
|
formats: []
|
||||||
build:
|
build:
|
||||||
image: latest
|
os: ubuntu-22.04
|
||||||
|
tools:
|
||||||
|
python: "3.8"
|
||||||
apt_packages:
|
apt_packages:
|
||||||
- ditaa
|
- ditaa
|
||||||
|
jobs:
|
||||||
|
pre_build:
|
||||||
|
- bash admin/rtd-checkout-main
|
||||||
python:
|
python:
|
||||||
version: 3.8
|
|
||||||
install:
|
install:
|
||||||
- requirements: admin/doc-requirements.txt
|
- requirements: admin/doc-requirements.txt
|
||||||
- requirements: admin/doc-read-the-docs.txt
|
- requirements: admin/doc-read-the-docs.txt
|
||||||
|
6
admin/rtd-checkout-main
Executable file
6
admin/rtd-checkout-main
Executable file
@ -0,0 +1,6 @@
|
|||||||
|
# See .readthedocs.yml
|
||||||
|
set -ex
|
||||||
|
if git symbolic-ref HEAD; then
|
||||||
|
git checkout origin/main -- doc/releases
|
||||||
|
fi
|
||||||
|
git status
|
Loading…
Reference in New Issue
Block a user