diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 08:26:56 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 08:26:56 +0300 |
| commit | 17e840a3b54e992233278f819d9c5ac2a938ba5f (patch) | |
| tree | 8453a115fe62cf5f1f7c1dab3cade7b10fe7a9de /docs/conf.py | |
| parent | 86e4d1844434b93b086efcd9448706effc980576 (diff) | |
| download | vyos-documentation-17e840a3b54e992233278f819d9c5ac2a938ba5f.tar.gz vyos-documentation-17e840a3b54e992233278f819d9c5ac2a938ba5f.zip | |
docs(conf.py): name the rolling docs as "rolling (current)", not stale circinus
The `current` branch's `release` literal was `'1.5.x (circinus)'` β
stale since circinus split off as its own LTS branch. The rendered
llms.txt verification on the RTD preview surfaced the bug as the
canonical version label of the rolling docs:
> This documentation covers 1.5.x (circinus).
β¦on a build whose URLs are `/en/rolling/`. The new build-time render
introduced by this PR makes the inconsistency a user-visible artifact
exposed to LLM consumers, so fix the source-of-truth literal here.
Now `release = 'rolling (current)'` and `version = 'rolling'`. Sphinx
also exposes `release` in the page footer ("v: rolling (current)")
and search metadata, so fixing this string is a single source-of-truth
change for the rolling docs.
Sagitta and circinus `release` strings are correct already
(`'1.4.x (sagitta)'` and `'1.5.x (circinus)'` respectively); no
cross-branch sweep needed for `release`.
Addresses CodeRabbit review feedback on PR #1874 (the originally pushed-back
release-mismatch finding β verification proved the push-back wrong).
\xf0\x9f\xa4\x96 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/conf.py b/docs/conf.py index 3ac6ca8d..f31dfbf4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,11 +26,16 @@ project = u'VyOS' copyright = u'2026, VyOS maintainers and contributors' author = u'VyOS maintainers and contributors' -# The short X.Y version -version = u'1.5' - -# The full version, including alpha/beta/rc tags -release = u'1.5.x (circinus)' +# The short X.Y version (rolling β next major; bumped at branch cut) +version = u'rolling' + +# The full version, including alpha/beta/rc tags. The `current` branch +# is the rolling tip and serves at /en/rolling/ on RTD; the literal +# below is exposed in the page footer ("v: rolling (current)") and is +# interpolated into _templates/llms.txt.j2 ("This documentation covers +# {{ release }}."). Pin this to a value that names what the rolling +# docs actually serve, not a stale LTS codename. +release = u'rolling (current)' # -- General configuration --------------------------------------------------- |