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 = []
  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.02
  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=rls1704
  70 .. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/t-rex/t-rex-installer.sh?h=rls1704
  71 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/t-rex/t-rex-stateless.py?h=rls1704
  72 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/rls1704/doc/tests.func.html
  73 .. _CSIT Testpmd Performance Tests Documentation: https://docs.fd.io/csit/rls1704/doc/tests.perf.html
  74 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/rls1704/doc/tests.func.html
  75 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/rls1704/doc/tests.perf.html
  76 .. _VPP test framework documentation: https://docs.fd.io/vpp/17.04/vpp_make_test/html/
  77 .. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-1704-all
  78 .. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-1704-all
  79 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-1704-ubuntu1604/
  80 """
  81
  82 # The language for content autogenerated by Sphinx. Refer to documentation
  83 # for a list of supported languages.
  84 #
  85 # This is also used if you do content translation via gettext catalogs.
  86 # Usually you set "language" from the command line for these cases.
  87 language = 'en'
  88
  89 # List of patterns, relative to source directory, that match files and
  90 # directories to ignore when looking for source files.
  91 # This patterns also effect to html_static_path and html_extra_path
  92 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  93
  94 # The name of the Pygments (syntax highlighting) style to use.
  95 pygments_style = 'sphinx'
  96
  97 # If true, `todo` and `todoList` produce output, else they produce nothing.
  98 todo_include_todos = False
  99
 100 #pdf_documents = [('index', u'rst2pdf', u'Sample rst2pdf doc', u'Your Name'),]
 101
 102
 103 # -- Options for HTML output ----------------------------------------------
 104
 105 # The theme to use for HTML and HTML Help pages.  See the documentation for
 106 # a list of builtin themes.
 107 #
 108 html_theme = 'sphinx_rtd_theme'
 109
 110 # Theme options are theme-specific and customize the look and feel of a theme
 111 # further.  For a list of options available for each theme, see the
 112 # documentation.
 113 #
 114 # html_theme_options = {}
 115
 116 # Add any paths that contain custom static files (such as style sheets) here,
 117 # relative to this directory. They are copied after the builtin static files,
 118 # so a file named "default.css" will overwrite the builtin "default.css".
 119 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
 120
 121 html_static_path = ['../../../docs/report/_static']
 122
 123 html_context = {
 124     'css_files': [
 125         '_static/theme_overrides.css',  # overrides for wide tables in RTD theme
 126         ],
 127     }
 128
 129 # -- Options for HTMLHelp output ------------------------------------------
 130
 131 # Output file base name for HTML help builder.
 132 htmlhelp_basename = u'CSIT 17.07 report'
 133
 134 # -- Options for LaTeX output ---------------------------------------------
 135
 136 latex_elements = {
 137     # The paper size ('letterpaper' or 'a4paper').
 138     #
 139     # 'papersize': 'letterpaper',
 140
 141     # The font size ('10pt', '11pt' or '12pt').
 142     #
 143     # 'pointsize': '10pt',
 144
 145     # Additional stuff for the LaTeX preamble.
 146     #
 147     # 'preamble': '',
 148
 149     # Latex figure (float) alignment
 150     #
 151     # 'figure_align': 'htbp',
 152 }
 153
 154 # Grouping the document tree into LaTeX files. List of tuples
 155 # (source start file, target name, title,
 156 #  author, documentclass [howto, manual, or own class]).
 157 latex_documents = [
 158     (master_doc, 'CSIT1707report.tex', u'CSIT 17.07 report',
 159      u'cisco', 'manual'),
 160 ]
 161
 162
 163 # -- Options for manual page output ---------------------------------------
 164
 165 # One entry per manual page. List of tuples
 166 # (source start file, name, description, authors, manual section).
 167 man_pages = [
 168     (master_doc, 'csit1707report', u'CSIT 17.07 report',
 169      [author], 1)
 170 ]
 171
 172
 173 # -- Options for Texinfo output -------------------------------------------
 174
 175 # Grouping the document tree into Texinfo files. List of tuples
 176 # (source start file, target name, title, author,
 177 #  dir menu entry, description, category)
 178 texinfo_documents = [
 179     (master_doc, 'CSIT1707report', u'CSIT 17.07 report',
 180      author, 'CSIT1707report', 'One line description of project.',
 181      'Miscellaneous'),
 182 ]