docs/conf.py

   1 master_doc = 'index'
   2 project = "Anuket Documentation"
   3 html_title = "Anuket Documentation"
   4 copyright = '2021, Anuket. Licensed under CC BY 4.0'
   5 author = 'Anuket Project of Linux Foundation Networking'
   6 extensions = ['sphinx.ext.intersphinx',
   7               'sphinx.ext.autosectionlabel'
   8              ]
   9 html_theme = "sphinx_material"
  10 exclude_patterns = [
  11     '**/.tox',
  12     'templates',                     # suppress warning that these files are not included in any toctree
  13     'how-to-use-docs/files',         # suppress warning that these files are not included in any toctree
  14     'development/feature.templates'  # suppress warning that these files are not included in any toctree
  15 ]
  16
  17 # The version info for the project you're documenting, acts as replacement for
  18 # |version| and |release|, also used in various other places throughout the
  19 # built documents.
  20 #
  21 # The short X.Y version.
  22 version = 'Latest'
  23 # The full version, including alpha/beta/rc tags.
  24 release = 'Latest'
  25 # The branch this project should link against for projects
  26 # following the stable-branch process. On the opnfvdocs stable branch
  27 # this should be set to 'stable/<release>' where '<release>' is the
  28 # current stable release (Ex: 'stable/gambia')
  29 branch = 'latest'
  30
  31 intersphinx_mapping = {}
  32 intersphinx_mapping['airship'] = ('https://docs.anuket.io/projects/airship/en/%s' % branch, None)
  33 #intersphinx_mapping['apex'] = ('https://opnfv-apex.readthedocs.io/en/%s' % branch, None)
  34 #intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None)
  35 intersphinx_mapping['auto'] = ('https://docs.anuket.io/projects/auto/en/%s' % branch, None)
  36 intersphinx_mapping['availability'] = ('https://opnfv-availability.readthedocs.io/en/%s' % branch, None)
  37 intersphinx_mapping['barometer'] = ('https://docs.anuket.io/projects/barometer/en/%s' % branch, None)
  38 #intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/%s' % branch, None)
  39 intersphinx_mapping['calipso'] = ('https://docs.anuket.io/projects/calipso/en/%s' % branch, None)
  40 intersphinx_mapping['cirv-sdv'] = ('https://docs.anuket.io/projects/cirv-sdv/en/%s' % branch, None)
  41 #intersphinx_mapping['clover'] = ('https://opnfv-clover.readthedocs.io/en/%s' % branch, None)
  42 #intersphinx_mapping['compass4nfv'] = ('https://opnfv-compass4nfv.readthedocs.io/en/%s' % branch, None)
  43 intersphinx_mapping['container4nfv'] = ('https://opnfv-container4nfv.readthedocs.io/en/%s' % branch, None)
  44 # intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None)
  45 #intersphinx_mapping['daisy'] = ('https://opnfv-daisy.readthedocs.io/en/%s' % branch, None)
  46 #intersphinx_mapping['doctor'] = ('https://opnfv-doctor.readthedocs.io/en/%s' % branch, None)
  47 intersphinx_mapping['dovetail'] = ('https://docs.anuket.io/projects/dovetail/en/%s' % branch, None)
  48 intersphinx_mapping['edgecloud'] = ('https://opnfv-edgecloud.readthedocs.io/en/%s' % branch, None)
  49 # intersphinx_mapping['fds'] = ('https://opnfv-fds.readthedocs.io/en/%s' % branch, None)
  50 #intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None)
  51 intersphinx_mapping['functest'] = ('https://docs.anuket.io/projects/functest/en/%s' % branch, None)
  52 #intersphinx_mapping['ipv6'] = ('https://opnfv-ipv6.readthedocs.io/en/%s' % branch, None)
  53 # intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/%s' % branch, None)
  54 # intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/%s' % branch, None)
  55 intersphinx_mapping['kuberef'] = ('https://docs.anuket.io/projects/kuberef/en/%s' % branch, None)
  56 intersphinx_mapping['nfvbench'] = ('https://docs.anuket.io/projects/nfvbench/en/%s' % branch, None)
  57 #intersphinx_mapping['onosfw'] = ('https://opnfv-onosfw.readthedocs.io/en/%s' % branch, None)
  58 #intersphinx_mapping['orchestra'] = ('https://opnfv-orchestra.readthedocs.io/en/%s' % branch, None)
  59 intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None)
  60 intersphinx_mapping['ovno'] = ('https://opnfv-ovno.readthedocs.io/en/%s' % branch, None)
  61 intersphinx_mapping['parser'] = ('https://opnfv-parser.readthedocs.io/en/%s' % branch, None)
  62 intersphinx_mapping['pharos'] = ('https://opnfv-pharos.readthedocs.io/en/%s' % branch, None)
  63 #intersphinx_mapping['promise'] = ('https://opnfv-promise.readthedocs.io/en/%s' % branch, None)
  64 #intersphinx_mapping['qtip'] = ('https://opnfv-qtip.readthedocs.io/en/%s' % branch, None)
  65 intersphinx_mapping['releng'] = ('https://docs.anuket.io/projects/releng/en/latest', None)
  66 intersphinx_mapping['releng-xci'] = ('https://opnfv-releng-xci.readthedocs.io/en/%s' % branch, None)
  67 intersphinx_mapping['samplevnf'] = ('https://docs.anuket.io/projects/samplevnf/en/%s' % branch, None)
  68 intersphinx_mapping['sdnvpn'] = ('https://opnfv-sdnvpn.readthedocs.io/en/%s' % branch, None)
  69 #intersphinx_mapping['sfc'] = ('https://opnfv-sfc.readthedocs.io/en/%s' % branch, None)
  70 #intersphinx_mapping['snaps'] = ('https://opnfv-snaps.readthedocs.io/en/%s' % branch, None)
  71 intersphinx_mapping['stor4nfv'] = ('https://opnfv-stor4nfv.readthedocs.io/en/%s' % branch, None)
  72 #intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/%s' % branch, None)
  73 intersphinx_mapping['vineperf'] = ('https://docs.anuket.io/projects/vineperf/en/%s' % branch, None)
  74 #intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None)
  75 intersphinx_mapping['cntt'] = ('https://cntt.readthedocs.io/en/%s' % branch, None)
  76
  77
  78 autosectionlabel_prefix_document = True
  79 autosectionlabel_maxdepth = 4
  80
  81 html_static_path = ['_static']
  82 templates_path = ['_templates']
  83
  84 html_show_sourcelink = False
  85 html_theme_options = {
  86     'nav_title': '',
  87      # Set the color and the accent color
  88     'color_primary': 'blue-grey,',
  89     'color_accent': 'white',
  90     # Visible levels of the global TOC; -1 means unlimited
  91     'globaltoc_depth': 0,
  92     # If False, expand all TOC entries
  93     'globaltoc_collapse': False,
  94     # If True, show hidden TOC entries
  95     'globaltoc_includehidden': False,
  96     'base_url': "https://docs.anuket.io/",
  97     'repo_url': 'https://gerrit.opnfv.org/',
  98     'repo_name': '',
  99     'repo_type': 'github',
 100 }
 101
 102 # Inverse png
 103 html_logo = '_static/anuket-logo.png'
 104 html_favicon = '_static/favicon.ico'