X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Ftools%2Fpresentation%2Fconf_cpta%2Fconf.py;h=53af4ed68a70872885cc7c3f96af039f96013ddd;hp=9b6e5f3bc15bd7bd22c4d85b05c9d15cf5a8ccb8;hb=37f7b3ead9eabc8c8d195ae168565c6f12eb8197;hpb=efdcf6470f6e15dcc918c70e5a61d10e10653f1e diff --git a/resources/tools/presentation/conf_cpta/conf.py b/resources/tools/presentation/conf_cpta/conf.py index 9b6e5f3bc1..53af4ed68a 100644 --- a/resources/tools/presentation/conf_cpta/conf.py +++ b/resources/tools/presentation/conf_cpta/conf.py @@ -18,7 +18,7 @@ import os import sys -sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath(u'.')) # -- General configuration ------------------------------------------------ @@ -29,23 +29,23 @@ 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 filenames. # 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. project = u'FD.io CSIT' -copyright = u'2018, FD.io' +copyright = u'2020, FD.io' author = u'FD.io CSIT' # The version info for the project you're documenting, acts as replacement for @@ -62,15 +62,15 @@ author = u'FD.io CSIT' # # 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 @@ -80,7 +80,7 @@ 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 @@ -91,13 +91,23 @@ html_theme = 'sphinx_rtd_theme' # 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/python3.8/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 + +# 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