import os
import sys
+import sphinx_rtd_theme
-sys.path.insert(0, os.path.abspath(u'.'))
+sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = [u'sphinxcontrib.programoutput',
- u'sphinx.ext.ifconfig']
+extensions = [
+ 'sphinxcontrib.programoutput',
+ 'sphinx.ext.ifconfig',
+ 'sphinx_rtd_theme'
+]
# Add any paths that contain templates here, relative to this directory.
-templates_path = [u'_templates']
+templates_path = ['_templates']
# The suffix(es) of source file names.
# You can specify multiple suffix as a list of string:
#
-source_suffix = [u'.rst', u'.md']
+source_suffix = ['.rst', '.md']
# The master toctree document.
-master_doc = u'index'
+master_doc = 'index'
# General information about the project.
-report_week = u'39'
-project = u'FD.io CSIT-2210.{week}'.format(week=report_week)
-copyright = u'2022, FD.io'
-author = u'FD.io CSIT'
+report_week = '39'
+project = 'FD.io CSIT-2210.{week}'.format(week=report_week)
+copyright = '2022, FD.io'
+author = 'FD.io CSIT'
-# The version info for the project you're documenting, acts as replacement for
+# The version info for the project yo're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-# version = u''
+# version = ''
# The full version, including alpha/beta/rc tags.
-# release = u''
+# release = ''
-rst_epilog = u"""
+rst_epilog = """
.. |release-1| replace:: {prev_release}
.. |srelease| replace:: {srelease}
.. |csit-release| replace:: CSIT-{csitrelease}
.. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu2004-x86_64/
.. _CSIT Testbed Setup: https://git.fd.io/csit/tree/fdio.infra.ansible?h={release}
.. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id}
-""".format(release=u'rls2210',
+""".format(release='rls2210',
report_week=report_week,
- prev_release=u'rls2206',
- srelease=u'2210',
- csitrelease=u'2210',
- csit_prev_release=u'2206',
- vpprelease=u'22.10',
- vpp_prev_release=u'22.06',
- dpdkrelease=u'22.07',
- dpdk_prev_release=u'22.03',
- sdpdkrelease=u'22.07',
- trex_version=u'v2.97',
- vpp_release_commit_id=u'0d352a97c5e3ad1f5f6eab18a978a14b0b9e06a8')
+ prev_release='rls2206',
+ srelease='2210',
+ csitrelease='2210',
+ csit_prev_release='2206',
+ vpprelease='22.10',
+ vpp_prev_release='22.06',
+ dpdkrelease='22.07',
+ dpdk_prev_release='22.03',
+ sdpdkrelease='22.07',
+ trex_version='v2.97',
+ vpp_release_commit_id='0d352a97c5e3ad1f5f6eab18a978a14b0b9e06a8')
# 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 = u'en'
+language = '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 = [u'_build', u'Thumbs.db', u'.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = u'sphinx'
+pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
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 = u'sphinx_rtd_theme'
+html_theme = '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 = {
- 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,
+ 'analytics_id': '',
+ 'analytics_anonymize_ip': False,
+ 'logo_only': False,
+ 'display_version': True,
+ 'prev_next_buttons_location': 'bottom',
+ 'style_external_links': False,
+ 'vcs_pageview_mode': '',
+ 'style_nav_header_background': '#2980b9',
# Toc options
- u'collapse_navigation': True,
- u'sticky_navigation': True,
- u'navigation_depth': 3,
- u'includehidden': True,
- u'titles_only': False
+ 'collapse_navigation': True,
+ 'sticky_navigation': True,
+ 'navigation_depth': 4,
+ 'includehidden': True,
+ '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 = [u'env/lib/python3.8/site-packages/sphinx_rtd_theme']
-# html_static_path = ['_build/_static']
-html_static_path = [u'_tmp/src/_static']
+html_static_path = ['_tmp/src/_static']
html_context = {
- u'css_files': [
+ 'css_files': [
+ '_static/css/theme.css',
+ '_static/css/badge_only.css',
# overrides for wide tables in RTD theme
- u'_static/theme_overrides.css'
+ '_static/theme_overrides.css',
]
}
# -- Options for LaTeX output ---------------------------------------------
-latex_engine = u'pdflatex'
+latex_engine = 'pdflatex'
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
- u'papersize': u'a4paper',
+ 'papersize': 'a4paper',
# The font size ('10pt', '11pt' or '12pt').
#
# Additional stuff for the LaTeX preamble.
#
- u'preamble': r'''
+ 'preamble': r'''
\usepackage{pdfpages}
\usepackage{svg}
\usepackage{charter}
# Latex figure (float) alignment
#
- u'figure_align': u'H',
+ 'figure_align': 'H',
# Latex font setup
#
- u'fontpkg': r'''
+ 'fontpkg': r'''
\renewcommand{\familydefault}{\sfdefault}
''',
# Latex other setup
#
- u'extraclassoptions': u'openany',
- u'sphinxsetup': r'''
+ 'extraclassoptions': 'openany',
+ 'sphinxsetup': r'''
TitleColor={RGB}{225,38,40},
InnerLinkColor={RGB}{62,62,63},
OuterLinkColor={RGB}{225,38,40},
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, u'csit.tex', u'CSIT REPORT', u'', u'manual'),
+ (master_doc, 'csit.tex', 'CSIT REPORT', '', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# If true, show URL addresses after external links.
#
-latex_show_urls = u'footnote'
+latex_show_urls = 'footnote'
# Documents to append as an appendix to all manuals.
#
Code Review / csit.git / blobdiff