diff options
Diffstat (limited to 'resources/tools/presentation/sphinx_conf/trending/conf.py')
-rw-r--r-- | resources/tools/presentation/sphinx_conf/trending/conf.py | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/resources/tools/presentation/sphinx_conf/trending/conf.py b/resources/tools/presentation/sphinx_conf/trending/conf.py new file mode 100644 index 0000000000..53af4ed68a --- /dev/null +++ b/resources/tools/presentation/sphinx_conf/trending/conf.py @@ -0,0 +1,113 @@ +# -*- 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. +# +import os +import sys + +sys.path.insert(0, os.path.abspath(u'.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# 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'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = [u'_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +source_suffix = [u'.rst', u'.md'] + +# The master toctree document. +master_doc = u'index' + +# General information about the project. +project = u'FD.io CSIT' +copyright = u'2020, FD.io' +author = u'FD.io CSIT' + +# The version info for the project you'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'' +# The full version, including alpha/beta/rc tags. +#release = u'' + +# 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' + +# 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'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = u'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- Options for HTML output ---------------------------------------------- + +# 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' + +# 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 = {} + +# 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_context = { + 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 + +# If false, no index is generated. +html_use_index = True + +# If true, the index is split into individual pages for each letter. +html_split_index = False |