import sphinx_bootstrap_theme
-import subprocess
+import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-# <! RTD Hack >
-subprocess.call(["rm", "-rf", "*"])
-# <!/ RTD Hack >
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc',
- 'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
+ 'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
+ 'sphinx.ext.intersphinx']
# Disable javasphinx generation until we have a solution to long build
# times. readthedocs timesout after 902 seconds.
master_doc = 'index'
# General information about the project.
-project = 'Documentation'
-copyright = '2017, OPNFV. Licensed under CC BY 4.0'
-author = 'Open Platform for NFV'
+project = ''
+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
# built documents.
#
# The short X.Y version.
-version = 'Colorado'
+version = 'Latest'
# The full version, including alpha/beta/rc tags.
-release = 'Colorado'
+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.
# 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.
# documentation.
# html_theme_options = {}
html_theme_options = {
- 'bootswatch_theme': "united",
+ 'bootswatch_theme': "journal",
+ 'navbar_sidebarrel': False,
}
# Add any paths that contain custom themes here, relative to this directory.
# 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
'Miscellaneous'),
]
+html_sidebars = {'**': ['localtoc.html', 'relations.html'],}
# Documents to append as an appendix to all manuals.
# texinfo_appendices = []
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False
-# intersphinx_mapping =
-# {'RTD':('http://opnfvdocsdemo.readthedocs.io/projects/', None)}
+intersphinx_mapping = {}
+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['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)
Code Review / opnfvdocs.git / blobdiff