From 3774787046a3b3124ba7bcc098d6364579950a55 Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Thu, 9 May 2019 13:48:05 -0700 Subject: [PATCH] Set Version and Release to Hunter Updates the 'branch' config which is used for intersphinx linking, and sets the version/release to Hunter. Switches projects not in this release to link against their latest docs as they don't have a 'stable-hunter' to reference. Includes an update to '.gitreview' to ensure `git-review` submits a patch against the correct branch. Change-Id: Id2f46b8fd7f71eb3e46b7698896ab1d4059345f7 Signed-off-by: Trevor Bramwell --- .gitreview | 1 + docs/conf.py | 47 +++++++++++++++++++++++------------------------ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.gitreview b/.gitreview index 1608e3a2c..cc4226779 100644 --- a/.gitreview +++ b/.gitreview @@ -2,3 +2,4 @@ host=gerrit.opnfv.org port=29418 project=opnfvdocs.git +defaultbranch=stable/hunter diff --git a/docs/conf.py b/docs/conf.py index 82c06fca2..d763a8ddd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,14 +42,13 @@ author = 'Open Platform for NFV' # built documents. # # The short X.Y version. -version = 'Latest' +version = 'Hunter' # 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' +release = 'Hunter' +# The RTD build this project should link against for intersphinx For +# stable branch builds this should be set to 'stable-' where +# '' is the current stable release (Ex: 'stable-gambia') +branch = 'stable-hunter' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -286,19 +285,19 @@ html_sidebars = {'**': ['localtoc.html', 'relations.html'],} intersphinx_mapping = {} intersphinx_mapping['apex'] = ('https://opnfv-apex.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None) +# intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/latest', None) intersphinx_mapping['availability'] = ('https://opnfv-availability.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['barometer'] = ('https://opnfv-barometer.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['calipso'] = ('https://opnfv-calipso.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/latest', None) +intersphinx_mapping['calipso'] = ('https://opnfv-calipso.readthedocs.io/en/latest', None) intersphinx_mapping['clover'] = ('https://opnfv-clover.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['compass4nfv'] = ('https://opnfv-compass4nfv.readthedocs.io/en/%s' % branch, None) +# intersphinx_mapping['compass4nfv'] = ('https://opnfv-compass4nfv.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['container4nfv'] = ('https://opnfv-container4nfv.readthedocs.io/en/%s' % branch, None) # intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['daisy'] = ('https://opnfv-daisy.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['daisy'] = ('https://opnfv-daisy.readthedocs.io/en/latest', None) intersphinx_mapping['doctor'] = ('https://opnfv-doctor.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['dovetail'] = ('https://opnfv-dovetail.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['dovetail'] = ('https://opnfv-dovetail.readthedocs.io/en/latest', None) intersphinx_mapping['edgecloud'] = ('https://opnfv-edgecloud.readthedocs.io/en/%s' % branch, None) # intersphinx_mapping['fds'] = ('https://opnfv-fds.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None) @@ -306,22 +305,22 @@ intersphinx_mapping['functest'] = ('https://opnfv-functest.readthedocs.io/en/%s' intersphinx_mapping['ipv6'] = ('https://opnfv-ipv6.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['nfvbench'] = ('https://opnfv-nfvbench.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['onosfw'] = ('https://opnfv-onosfw.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['orchestra'] = ('https://opnfv-orchestra.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['nfvbench'] = ('https://opnfv-nfvbench.readthedocs.io/en/latest', None) +intersphinx_mapping['onosfw'] = ('https://opnfv-onosfw.readthedocs.io/en/latest', None) +###intersphinx_mapping['orchestra'] = ('https://opnfv-orchestra.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['ovno'] = ('https://opnfv-ovno.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['ovno'] = ('https://opnfv-ovno.readthedocs.io/en/latest', None) intersphinx_mapping['parser'] = ('https://opnfv-parser.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['pharos'] = ('https://opnfv-pharos.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['promise'] = ('https://opnfv-promise.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['qtip'] = ('https://opnfv-qtip.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['pharos'] = ('https://opnfv-pharos.readthedocs.io/en/latest', None) +intersphinx_mapping['promise'] = ('https://opnfv-promise.readthedocs.io/en/latest', None) +intersphinx_mapping['qtip'] = ('https://opnfv-qtip.readthedocs.io/en/latest', None) intersphinx_mapping['releng'] = ('https://opnfv-releng.readthedocs.io/en/latest', None) -intersphinx_mapping['releng-xci'] = ('https://opnfv-releng-xci.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['releng-xci'] = ('https://opnfv-releng-xci.readthedocs.io/en/latest', None) intersphinx_mapping['samplevnf'] = ('https://opnfv-samplevnf.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['sdnvpn'] = ('https://opnfv-sdnvpn.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['sdnvpn'] = ('https://opnfv-sdnvpn.readthedocs.io/en/latest', None) intersphinx_mapping['sfc'] = ('https://opnfv-sfc.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['snaps'] = ('https://opnfv-snaps.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['stor4nfv'] = ('https://opnfv-stor4nfv.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/latest', None) intersphinx_mapping['vswitchperf'] = ('https://opnfv-vswitchperf.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None) -- 2.16.6