Add note for show_other_versions
Point out the versions need to be found when this option is used. With all the path changes, this is currently not the case for *any* project. Change-Id: Ie439db0bd5a1d5fbdb63eb3489a6c50bdf07ed6f
This commit is contained in:
parent
725ec60d9c
commit
cb33fecb2d
@ -101,6 +101,17 @@ Using the theme
|
||||
|
||||
html_theme_options = {"show_other_versions": "True"}
|
||||
|
||||
.. warning::
|
||||
|
||||
Use this only if the last *5* tagged versions are accessible
|
||||
from the html path where the documents are currently published.
|
||||
Remember that the OpenStack infra scripts publish now to
|
||||
``docs.openstack.org/REPO/latest`` and
|
||||
``docs.openstack.org/REPO/TAG``. Thus, check first that the
|
||||
URLs are correct for your repository before using this option.
|
||||
|
||||
Do not use this for release-notes as they are always published
|
||||
as one document with internal versioning.
|
||||
|
||||
Demonstration example
|
||||
=====================
|
||||
|
Loading…
x
Reference in New Issue
Block a user