docs/conf.py

   1 project = 'kuberef'
   2 html_title = "kuberef"
   3 copyright = '2023, Anuket. Licensed under CC BY 4.0'
   4 author = 'Anuket Project of Linux Foundation Networking'
   5
   6 exclude_patterns = [
   7     '.tox',
   8     'README.rst'
   9 ]
  10 extensions = [
  11     'sphinx.ext.intersphinx',
  12     'sphinx.ext.autosectionlabel'
  13 ]
  14 html_theme = "piccolo_theme"
  15 linkcheck_ignore = [
  16     'http://127.0.0.1'
  17 ]
  18 intersphinx_mapping = {
  19     'cntt': ('https://cntt.readthedocs.io/en/latest/', None),
  20     'ref_model': ('https://cntt.readthedocs.io/projects/rm/en/latest/', None),
  21     'ref_arch_kubernetes': ('https://cntt.readthedocs.io/projects/ra2/en/latest/', None),
  22     'ref_cert_RC2': ('https://cntt.readthedocs.io/projects/rc2/en/latest/', None),
  23     'ref_impl_RI2': ('https://cntt.readthedocs.io/projects/ri2/en/latest/', None)
  24 }
  25 autosectionlabel_prefix_document = True
  26 autosectionlabel_maxdepth = 3
  27 numfig = True
  28 numfig_format = {'figure': 'Figure %s', 'table': 'Table %s',
  29                  'code-block': 'Listing %s', 'section': 'Section %s'}
  30
  31 html_static_path = ['_static']
  32 templates_path = ['_templates']
  33 html_css_files = [
  34     'custom.css',
  35 ]
  36
  37 html_show_sourcelink = False
  38 html_theme_options = {
  39     # If False, expand all TOC entries
  40     'globaltoc_collapse': False,
  41     # If True, show hidden TOC entries
  42     'globaltoc_includehidden': False,
  43 }
  44
  45 # Inverse png
  46 html_logo = '_static/anuket-logo.png'
  47 html_favicon = '_static/favicon.ico'