From: Trevor Bramwell <tbramwell@linuxfoundation.org>
Date: Mon, 17 Sep 2018 22:10:30 +0000 (-0700)
Subject: Create 'branch' variable in conf.py for linking
X-Git-Tag: opnfv-10.0.0~146^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=4933715504cc28b043fc8a042bc3799d08c48069;p=opnfvdocs.git

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>
---

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)