X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Fconf.py;h=d590ac475c111b4700727951dc062d5f0812b2ad;hb=cadb1e9cb023a10a749f862f7680db89d07cd23b;hp=bab9d7bff13a1b388b292ed23a55a0249a6f3ac5;hpb=df89827146946a4986d4901c60fc7a8109c72b4d;p=opnfvdocs.git diff --git a/docs/conf.py b/docs/conf.py index bab9d7bff..d590ac475 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,8 +34,8 @@ master_doc = 'index' # General information about the project. project = '' -copyright = '2017, OPNFV. Licensed under CC BY 4.0' -author = 'Open Platform for NFV' +copyright = '2021, Anuket. Licensed under CC BY 4.0' +author = 'Anuket Project of Linux Foundation Networking' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -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. @@ -62,7 +67,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = [] +exclude_patterns = ['templates/*', 'how-to-use-docs/files/*', 'development/opnfvsecguide/*'] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -120,7 +125,7 @@ html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = '_static/opnfv-logo.png' +html_logo = '_static/anuket-logo.png' # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 @@ -280,8 +285,46 @@ 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['airship'] = ('https://opnfv-airship.readthedocs.io/en/%s' % branch, None) +#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['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['cirv-sdv'] = ('https://opnfv-cirv-sdv.readthedocs.io/en/%s' % branch, 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['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['doctor'] = ('https://opnfv-doctor.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['dovetail'] = ('https://opnfv-dovetail.readthedocs.io/en/%s' % branch, 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) +intersphinx_mapping['functest'] = ('https://opnfv-functest.readthedocs.io/en/%s' % branch, None) +#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['kuberef'] = ('https://opnfv-kuberef.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['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['ovno'] = ('https://opnfv-ovno.readthedocs.io/en/%s' % branch, 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['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['releng-xci'] = ('https://opnfv-releng-xci.readthedocs.io/en/%s' % branch, 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['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['vineperf'] = ('https://opnfv-vineperf.readthedocs.io/en/%s' % branch, None) +#intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None)