resources/tools/report_gen/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # CSIT 17.01 report documentation build configuration file, created by
   4 # sphinx-quickstart on Sun Jan 15 09:49:36 2017.
   5 #
   6 # This file is execfile()d with the current directory set to its
   7 # containing dir.
   8 #
   9 # Note that not all possible configuration values are present in this
  10 # autogenerated file.
  11 #
  12 # All configuration values have a default; values that are commented out
  13 # serve to show the default.
  14
  15 # If extensions (or modules to document with autodoc) are in another directory,
  16 # add these directories to sys.path here. If the directory is relative to the
  17 # documentation root, use os.path.abspath to make it absolute, like shown here.
  18 #
  19 import os
  20 import sys
  21
  22 sys.path.insert(0, os.path.abspath('.'))
  23
  24 # -- General configuration ------------------------------------------------
  25
  26 # If your documentation needs a minimal Sphinx version, state it here.
  27 #
  28 # needs_sphinx = '1.0'
  29
  30 # Add any Sphinx extension module names here, as strings. They can be
  31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  32 # ones.
  33 extensions = ['sphinxcontrib.programoutput']
  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'2017, 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:: rls1704
  62 .. |vpp-release| replace:: VPP-17.07 release
  63 .. |vpp-release-1| replace:: VPP-17.04 release
  64 .. |dpdk-release| replace:: DPDK 17.05
  65 .. |trex-release| replace:: TRex v2.25
  66 .. |virl-image-ubuntu| replace:: ubuntu-16.04.1_2017-02-23_1.8
  67 .. |virl-image-centos| replace:: centos-7.3-1611_2017-02-23_1.4
  68
  69 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h=rls1707
  70 .. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h=rls1707
  71 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h=rls1707
  72 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/rls1707/doc/tests.vpp.func.html
  73 .. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/rls1707/doc/tests.vpp.perf.html
  74 .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/rls1707/doc/tests.dpdk.perf.html
  75 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/rls1707/doc/tests.vpp.func.html
  76 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/rls1707/doc/tests.vpp.perf.html
  77 .. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/rls1707/doc/tests.nsh_sfc.func.html
  78 .. _VPP test framework documentation: https://docs.fd.io/vpp/17.07/vpp_make_test/html/
  79 .. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-1707-all
  80 .. _FD.io test executor vpp functional jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-1707-ubuntu1604-virl/lastSuccessfulBuild
  81 .. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-1707-all
  82 .. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-1707-ubuntu1604/lastSuccessfulBuild
  83 .. _FD.io test executor honeycomb performance jobs: https://jenkins.fd.io/view/hc2vpp/job/hc2vpp-csit-perf-master-ubuntu1604/lastSuccessfulBuild
  84 .. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-1707-ubuntu1604-virl/lastSuccessfulBuild
  85 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-1707-ubuntu1604/
  86 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-1707-ubuntu1604/
  87 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h=rls1707
  88 """
  89
  90 # The language for content autogenerated by Sphinx. Refer to documentation
  91 # for a list of supported languages.
  92 #
  93 # This is also used if you do content translation via gettext catalogs.
  94 # Usually you set "language" from the command line for these cases.
  95 language = 'en'
  96
  97 # List of patterns, relative to source directory, that match files and
  98 # directories to ignore when looking for source files.
  99 # This patterns also effect to html_static_path and html_extra_path
 100 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 101
 102 # The name of the Pygments (syntax highlighting) style to use.
 103 pygments_style = 'sphinx'
 104
 105 # If true, `todo` and `todoList` produce output, else they produce nothing.
 106 todo_include_todos = False
 107
 108 # pdf_documents = [('index', u'rst2pdf', u'Sample rst2pdf doc', u'Your Name'),]
 109
 110
 111 # -- Options for HTML output ----------------------------------------------
 112
 113 # The theme to use for HTML and HTML Help pages.  See the documentation for
 114 # a list of builtin themes.
 115 #
 116 html_theme = 'sphinx_rtd_theme'
 117
 118 # Theme options are theme-specific and customize the look and feel of a theme
 119 # further.  For a list of options available for each theme, see the
 120 # documentation.
 121 #
 122 # html_theme_options = {}
 123
 124 # Add any paths that contain custom static files (such as style sheets) here,
 125 # relative to this directory. They are copied after the builtin static files,
 126 # so a file named "default.css" will overwrite the builtin "default.css".
 127 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
 128
 129 html_static_path = ['../../../docs/report/_static']
 130
 131 html_context = {
 132     'css_files': [
 133         '_static/theme_overrides.css',  # overrides for wide tables in RTD theme
 134         ],
 135     }