openstackdocstheme/releasenotes/notes/add-openstackdocs_auto_version-option-fd03f20373eede39.yaml
Stephen Finucane 2b2e4e50b6 Add 'openstackdocs_auto_version' config option, path checking
Rather than relying on magic values to determine whether we should
attempt to auto-version documentation, start checking the paths for
commonly unversioned source doc paths and add an explicit knob to turn
this on or off.

Change-Id: Iecc3fa6f20f1aa92fcffe2b8adb0cd0da1aa17e4
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Closes-Bug: #1843976
2020-04-24 12:04:21 +01:00

14 lines
598 B
YAML

---
features:
- |
A new config option, ``openstackdocs_auto_version``, has been added. This
can be used to disable auto-versioning of documentation for things like
release notes or API references.
upgrade:
- |
The ``openstackdocs_auto_version`` option must be configured to disable
auto-versioning of documentation. Previously, the extension would check for
an empty string (``''``) and, if present, use this to indicate that the
document should be unversioned. However, this only worked if building
documentation using the ``build_sphinx`` distutils extension.