From 04446f1a5302306eaace8ca041e13827a4f6c6b7 Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Mon, 17 Sep 2018 15:10:30 -0700 Subject: 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 (cherry picked from commit 4933715504cc28b043fc8a042bc3799d08c48069) --- docs/conf.py | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4e5542820..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/' where '' 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,10 +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['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) -- cgit 1.2.3-korg