summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTrevor Bramwell <tbramwell@linuxfoundation.org>2018-09-17 15:10:30 -0700
committerTrevor Bramwell <tbramwell@linuxfoundation.org>2018-10-29 12:29:57 -0700
commit4933715504cc28b043fc8a042bc3799d08c48069 (patch)
treec63933023a729304041602a302523f527494076f
parent131635a3c8cbf0781c08e7ccb9ea51615785f367 (diff)
Create 'branch' variable in conf.py for linking
This will be used for linking against the correct version of the documentation on other projects when this project branches. Change-Id: I86391eb8ad1428b70f537288048c2c1b4597e928 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
-rw-r--r--docs/conf.py19
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/conf.py b/docs/conf.py
index ef67ef138..08b1d6f38 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -45,6 +45,11 @@ author = 'Open Platform for NFV'
version = 'Latest'
# The full version, including alpha/beta/rc tags.
release = 'Latest'
+# The branch this project should link against for projects
+# following the stable-branch process. On the opnfvdocs stable branch
+# this should be set to 'stable/<release>' where '<release>' is the
+# current stable release (Ex: 'stable/gambia')
+branch = 'latest'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -280,11 +285,11 @@ html_sidebars = {'**': ['localtoc.html', 'relations.html'],}
# texinfo_no_detailmenu = False
intersphinx_mapping = {}
-intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/latest', None)
-intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/latest', None)
-intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/latest', None)
-intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/latest', None)
+intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/%s' % branch, None)
intersphinx_mapping['releng'] = ('https://opnfv-releng.readthedocs.io/en/latest', None)
-intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/latest', None)
-intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/latest', None)
-intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/latest', None)
+intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None)