openstack
/
openstackdocstheme
Code Issues Proposed changes

Don't offer to show unmaintained versions 

Versions older than Zed are now either Unmaintained or EOL. In order to
avoid readers selecting those versions by mistake, bump the default
value for earliest_published_series from mitake to zed. Documentation
for older versions is still published and accessible via direct links.

Projects that want their readers to still access older documentation via
the version selector can do so by overriding the
earliest_published_series value in their docs config.

Change-Id: I5a0cfcdc787f7fcf814526de761ea54479ab30db
This commit is contained in:
Dr. Jens Harbott 2024-04-05 14:32:25 +02:00
parent 5b20fd8baf
commit d0a1d47a55
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
openstackdocstheme/ext.py
View File

@ -79,14 +79,14 @@ def _get_other_versions(app):
all_series = list(set(all_series))
all_series.sort(key=_ref_sort_key)
# NOTE(dhellmann): Given when this feature was implemented, we
# assume that the earliest version we can link to is for
# mitaka. Projects that have older docs online can set the option
# NOTE(frickler): Since older versions are now unmaintained,
# assume that the earliest version we want to link to is for
# zed. Projects that have older docs online can set the option
# to indicate another start point. Projects that come later should
# automatically include everything they actually have available
# because the start point is not present in the list.
earliest_desired = app.config.html_theme_options.get(
'earliest_published_series', 'mitaka')
'earliest_published_series', 'zed')
if earliest_desired and earliest_desired in all_series:
interesting_series = all_series[all_series.index(earliest_desired):]
else: