aboutsummaryrefslogtreecommitdiffstats
path: root/resources/tools/presentation/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'resources/tools/presentation/conf.py')
-rw-r--r--resources/tools/presentation/conf.py205
1 files changed, 103 insertions, 102 deletions
diff --git a/resources/tools/presentation/conf.py b/resources/tools/presentation/conf.py
index ae781bdac8..66dc46952c 100644
--- a/resources/tools/presentation/conf.py
+++ b/resources/tools/presentation/conf.py
@@ -1,25 +1,26 @@
# -*- coding: utf-8 -*-
-#
-# CSIT report documentation build configuration file
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
+"""CSIT report documentation build configuration file
+
+This file is execfile()d with the current directory set to its
+containing dir.
+
+Note that not all possible configuration values are present in this
+autogenerated file.
+
+All configuration values have a default; values that are commented out
+serve to show the default.
+
+If extensions (or modules to document with autodoc) are in another directory,
+add these directories to sys.path here. If the directory is relative to the
+documentation root, use os.path.abspath to make it absolute, like shown here.
+"""
import os
import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(u'.'))
# -- General configuration ------------------------------------------------
@@ -30,22 +31,22 @@ sys.path.insert(0, os.path.abspath('.'))
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = ['sphinxcontrib.programoutput',
- 'sphinx.ext.ifconfig']
+extensions = [u'sphinxcontrib.programoutput',
+ u'sphinx.ext.ifconfig']
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = [u'_templates']
# The suffix(es) of source file names.
# You can specify multiple suffix as a list of string:
#
-source_suffix = ['.rst', '.md']
+source_suffix = [u'.rst', u'.md']
# The master toctree document.
-master_doc = 'index'
+master_doc = u'index'
# General information about the project.
-report_week = '38'
+report_week = u'38'
project = u'FD.io CSIT-1908.{week}'.format(week=report_week)
copyright = u'2019, FD.io'
author = u'FD.io CSIT'
@@ -59,7 +60,7 @@ author = u'FD.io CSIT'
# The full version, including alpha/beta/rc tags.
# release = u''
-rst_epilog = """
+rst_epilog = u"""
.. |release-1| replace:: {prev_release}
.. |srelease| replace:: {srelease}
.. |csit-release| replace:: CSIT-{csitrelease}
@@ -108,35 +109,35 @@ rst_epilog = """
.. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
.. _K8s configuration files: https://github.com/FDio/csit/tree/{release}/resources/templates/kubernetes
.. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id}
-""".format(release='rls1908',
+""".format(release=u'rls1908',
report_week=report_week,
- prev_release='rls1904',
- srelease='1908',
- csitrelease='1908',
- csit_prev_release='1904',
- vpprelease='19.08',
- vpp_prev_release='19.04',
- dpdkrelease='19.05',
- sdpdkrelease='1905',
- trex_version='v2.54',
- csit_ubuntu_ver='csit-ubuntu-16.04.1_2019-03-27_2.4',
- csit_centos_ver='csit-centos-7.6-1810_2019-05-20_2.5',
- vpp_release_commit_id='1c586de48cc76fc6eac50f5d87003e2a80aa43e7')
+ prev_release=u'rls1904',
+ srelease=u'1908',
+ csitrelease=u'1908',
+ csit_prev_release=u'1904',
+ vpprelease=u'19.08',
+ vpp_prev_release=u'19.04',
+ dpdkrelease=u'19.05',
+ sdpdkrelease=u'1905',
+ trex_version=u'v2.54',
+ csit_ubuntu_ver=u'csit-ubuntu-16.04.1_2019-03-27_2.4',
+ csit_centos_ver=u'csit-centos-7.6-1810_2019-05-20_2.5',
+ vpp_release_commit_id=u'1c586de48cc76fc6eac50f5d87003e2a80aa43e7')
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
-language = 'en'
+language = u'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = u'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
@@ -146,40 +147,41 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'sphinx_rtd_theme'
+html_theme = u'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
- 'canonical_url': '',
- 'analytics_id': '',
- 'logo_only': False,
- 'display_version': True,
- 'prev_next_buttons_location': 'bottom',
- 'style_external_links': False,
+ u'canonical_url': u'',
+ u'analytics_id': u'',
+ u'logo_only': False,
+ u'display_version': True,
+ u'prev_next_buttons_location': u'bottom',
+ u'style_external_links': False,
# Toc options
- 'collapse_navigation': True,
- 'sticky_navigation': True,
- 'navigation_depth': 3,
- 'includehidden': True,
- 'titles_only': False
+ u'collapse_navigation': True,
+ u'sticky_navigation': True,
+ u'navigation_depth': 3,
+ u'includehidden': True,
+ u'titles_only': False
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
+html_theme_path = [u'env/lib/python2.7/site-packages/sphinx_rtd_theme']
# html_static_path = ['_build/_static']
-html_static_path = ['_tmp/src/_static']
+html_static_path = [u'_tmp/src/_static']
html_context = {
- 'css_files': [
- '_static/theme_overrides.css', # overrides for wide tables in RTD theme
- ],
- }
+ u'css_files': [
+# overrides for wide tables in RTD theme
+ u'_static/theme_overrides.css'
+ ]
+}
# If false, no module index is generated.
html_domain_indices = True
@@ -192,59 +194,58 @@ html_split_index = False
# -- Options for LaTeX output ---------------------------------------------
-latex_engine = 'pdflatex'
+latex_engine = u'pdflatex'
latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #
- 'papersize': 'a4paper',
-
- # The font size ('10pt', '11pt' or '12pt').
- #
- #'pointsize': '10pt',
-
- # Additional stuff for the LaTeX preamble.
- #
- 'preamble': r'''
- \usepackage{pdfpages}
- \usepackage{svg}
- \usepackage{charter}
- \usepackage[defaultsans]{lato}
- \usepackage{inconsolata}
- \usepackage{csvsimple}
- \usepackage{longtable}
- \usepackage{booktabs}
- ''',
-
- # Latex figure (float) alignment
- #
- 'figure_align': 'H',
-
- # Latex font setup
- #
- 'fontpkg': r'''
- \renewcommand{\familydefault}{\sfdefault}
- ''',
-
- # Latex other setup
- #
- 'extraclassoptions': 'openany',
- 'sphinxsetup': r'''
- TitleColor={RGB}{225,38,40},
- InnerLinkColor={RGB}{62,62,63},
- OuterLinkColor={RGB}{225,38,40},
- shadowsep=0pt,
- shadowsize=0pt,
- shadowrule=0pt
- '''
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ u'papersize': u'a4paper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ #'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ u'preamble': r'''
+ \usepackage{pdfpages}
+ \usepackage{svg}
+ \usepackage{charter}
+ \usepackage[defaultsans]{lato}
+ \usepackage{inconsolata}
+ \usepackage{csvsimple}
+ \usepackage{longtable}
+ \usepackage{booktabs}
+ ''',
+
+ # Latex figure (float) alignment
+ #
+ u'figure_align': u'H',
+
+ # Latex font setup
+ #
+ u'fontpkg': r'''
+ \renewcommand{\familydefault}{\sfdefault}
+ ''',
+
+ # Latex other setup
+ #
+ u'extraclassoptions': u'openany',
+ u'sphinxsetup': r'''
+ TitleColor={RGB}{225,38,40},
+ InnerLinkColor={RGB}{62,62,63},
+ OuterLinkColor={RGB}{225,38,40},
+ shadowsep=0pt,
+ shadowsize=0pt,
+ shadowrule=0pt
+ '''
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'csit.tex', u'CSIT REPORT',
- u'', 'manual'),
+ (master_doc, u'csit.tex', u'CSIT REPORT', u'', u'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -263,7 +264,7 @@ latex_show_pagerefs = True
# If true, show URL addresses after external links.
#
-latex_show_urls = 'footnote'
+latex_show_urls = u'footnote'
# Documents to append as an appendix to all manuals.
#