resources/tools/presentation/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # CSIT report documentation build configuration file
   4 #
   5 # This file is execfile()d with the current directory set to its
   6 # containing dir.
   7 #
   8 # Note that not all possible configuration values are present in this
   9 # autogenerated file.
  10 #
  11 # All configuration values have a default; values that are commented out
  12 # serve to show the default.
  13
  14 # If extensions (or modules to document with autodoc) are in another directory,
  15 # add these directories to sys.path here. If the directory is relative to the
  16 # documentation root, use os.path.abspath to make it absolute, like shown here.
  17 #
  18 import os
  19 import sys
  20
  21 sys.path.insert(0, os.path.abspath('.'))
  22
  23 # -- General configuration ------------------------------------------------
  24
  25 # If your documentation needs a minimal Sphinx version, state it here.
  26 #
  27 # needs_sphinx = '1.0'
  28
  29 # Add any Sphinx extension module names here, as strings. They can be
  30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  31 # ones.
  32 extensions = ['sphinxcontrib.programoutput',
  33               'sphinx.ext.ifconfig']
  34
  35 # Add any paths that contain templates here, relative to this directory.
  36 templates_path = ['_templates']
  37
  38 # The suffix(es) of source filenames.
  39 # You can specify multiple suffix as a list of string:
  40 #
  41 source_suffix = ['.rst', '.md']
  42
  43 # The master toctree document.
  44 master_doc = 'index'
  45
  46 # General information about the project.
  47 project = u'FD.io CSIT'
  48 copyright = u'2018, FD.io'
  49 author = u'FD.io CSIT'
  50
  51 # The version info for the project you're documenting, acts as replacement for
  52 # |version| and |release|, also used in various other places throughout the
  53 # built documents.
  54 #
  55 # The short X.Y version.
  56 #version = u''
  57 # The full version, including alpha/beta/rc tags.
  58 #release = u''
  59
  60 rst_epilog = """
  61 .. |release-1| replace:: rls1710
  62 .. |vpp-release| replace:: VPP-{vpprelease} release
  63 .. |vpp-release-1| replace:: VPP-17.10 release
  64 .. |dpdk-release| replace:: DPDK 17.11
  65 .. |trex-release| replace:: TRex v2.35
  66 .. |virl-image-ubuntu| replace:: ubuntu-16.04.1_2017-10-21_2.0
  67 .. |virl-image-centos| replace:: centos-7.3-1611_2017-02-23_1.4
  68
  69 .. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.pdf
  70 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release}
  71 .. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release}
  72 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h={release}
  73 .. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h={release}
  74 .. _VIRL images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release}
  75 .. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release}
  76 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.honeycomb.html
  77 .. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.honeycomb.html
  78 .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html
  79 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.html
  80 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.html
  81 .. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.nsh_sfc.func.html
  82 .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/
  83 .. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-{srelease}-all
  84 .. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-{srelease}-all
  85 .. _FD.io test executor vpp functional jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl/lastSuccessfulBuild
  86 .. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-{srelease}-all
  87 .. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-{srelease}-ubuntu1604/lastSuccessfulBuild
  88 .. _FD.io test executor honeycomb performance jobs: https://jenkins.fd.io/view/hc2vpp/job/hc2vpp-csit-perf-master-ubuntu1604/lastSuccessfulBuild
  89 .. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-{srelease}-ubuntu1604-virl/lastSuccessfulBuild
  90 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1604/
  91 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
  92 """.format(release='rls1801', srelease='1801', vpprelease='18.01')
  93
  94 # The language for content autogenerated by Sphinx. Refer to documentation
  95 # for a list of supported languages.
  96 #
  97 # This is also used if you do content translation via gettext catalogs.
  98 # Usually you set "language" from the command line for these cases.
  99 language = 'en'
 100
 101 # List of patterns, relative to source directory, that match files and
 102 # directories to ignore when looking for source files.
 103 # This patterns also effect to html_static_path and html_extra_path
 104 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 105
 106 # The name of the Pygments (syntax highlighting) style to use.
 107 pygments_style = 'sphinx'
 108
 109 # If true, `todo` and `todoList` produce output, else they produce nothing.
 110 todo_include_todos = False
 111
 112 # -- Options for HTML output ----------------------------------------------
 113
 114 # The theme to use for HTML and HTML Help pages.  See the documentation for
 115 # a list of builtin themes.
 116 #
 117 html_theme = 'sphinx_rtd_theme'
 118
 119 # Theme options are theme-specific and customize the look and feel of a theme
 120 # further.  For a list of options available for each theme, see the
 121 # documentation.
 122 #
 123 # html_theme_options = {}
 124
 125 # Add any paths that contain custom static files (such as style sheets) here,
 126 # relative to this directory. They are copied after the builtin static files,
 127 # so a file named "default.css" will overwrite the builtin "default.css".
 128 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
 129
 130 # html_static_path = ['_build/_static']
 131 html_static_path = ['_tmp/src/_static']
 132
 133 html_context = {
 134     'css_files': [
 135         '_static/theme_overrides.css',  # overrides for wide tables in RTD theme
 136         ],
 137     }
 138
 139 # -- Options for LaTeX output ---------------------------------------------
 140
 141 latex_engine = 'pdflatex'
 142
 143 latex_elements = {
 144      # The paper size ('letterpaper' or 'a4paper').
 145      #
 146      'papersize': 'a4paper',
 147
 148      # The font size ('10pt', '11pt' or '12pt').
 149      #
 150      #'pointsize': '10pt',
 151
 152      # Additional stuff for the LaTeX preamble.
 153      #
 154      'preamble': r'''
 155          \usepackage{pdfpages}
 156          \usepackage{svg}
 157          \usepackage{charter}
 158          \usepackage[defaultsans]{lato}
 159          \usepackage{inconsolata}
 160          \usepackage{csvsimple}
 161          \usepackage{longtable}
 162          \usepackage{booktabs}
 163      ''',
 164
 165      # Latex figure (float) alignment
 166      #
 167      'figure_align': 'H',
 168
 169      # Latex font setup
 170      #
 171      'fontpkg': r'''
 172          \renewcommand{\familydefault}{\sfdefault}
 173      ''',
 174
 175      # Latex other setup
 176      #
 177      'extraclassoptions': 'openany',
 178      'sphinxsetup': r'''
 179          TitleColor={RGB}{225,38,40},
 180          InnerLinkColor={RGB}{62,62,63},
 181          OuterLinkColor={RGB}{225,38,40},
 182          shadowsep=0pt,
 183          shadowsize=0pt,
 184          shadowrule=0pt
 185      '''
 186 }
 187
 188 # Grouping the document tree into LaTeX files. List of tuples
 189 # (source start file, target name, title,
 190 #  author, documentclass [howto, manual, or own class]).
 191 latex_documents = [
 192     (master_doc, 'csit.tex', u'CSIT REPORT',
 193      u'', 'manual'),
 194 ]
 195
 196 # The name of an image file (relative to this directory) to place at the top of
 197 # the title page.
 198 #
 199 # latex_logo = 'fdio.pdf'
 200
 201 # For "manual" documents, if this is true, then toplevel headings are parts,
 202 # not chapters.
 203 #
 204 # latex_use_parts = True
 205
 206 # If true, show page references after internal links.
 207 #
 208 latex_show_pagerefs = True
 209
 210 # If true, show URL addresses after external links.
 211 #
 212 latex_show_urls = 'footnote'
 213
 214 # Documents to append as an appendix to all manuals.
 215 #
 216 # latex_appendices = []
 217
 218 # It false, will not define \strong, \code,     itleref, \crossref ... but only
 219 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
 220 # packages.
 221 #
 222 # latex_keep_old_macro_names = True
 223
 224 # If false, no module index is generated.
 225 #
 226 # latex_domain_indices = True