X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Ftools%2Fdoc_gen%2Fsrc%2Fconf.py;h=02707665adb5e104d35dad1fff3ce3f4b5d0fb17;hb=refs%2Fchanges%2F48%2F33548%2F8;hp=1ebbbe79212ad0b2e0f501168707d22deb9bd93f;hpb=0cedc513bbb86fbdaf2550d99863ea8c520ef49b;p=csit.git diff --git a/resources/tools/doc_gen/src/conf.py b/resources/tools/doc_gen/src/conf.py index 1ebbbe7921..02707665ad 100644 --- a/resources/tools/doc_gen/src/conf.py +++ b/resources/tools/doc_gen/src/conf.py @@ -19,7 +19,7 @@ import os import sys -sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath(u".")) # -- General configuration ------------------------------------------------ @@ -31,31 +31,26 @@ sys.path.insert(0, os.path.abspath('.')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinxcontrib_robotdoc', + u"sphinx.ext.autodoc", + u"sphinx.ext.doctest", + u"sphinxcontrib_robotdoc" ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = [u"_templates"] -# The suffix(es) of source filenames. +# The suffix(es) of source file names. # You can specify multiple suffix as a list of string: # -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -# -# source_encoding = 'utf-8-sig' +source_suffix = [u".rst", u".md"] # The master toctree document. -master_doc = 'index' +master_doc = u"index" # General information about the project. -project = u'CSIT' -copyright = u'2018, FD.io' -author = u'CSIT' +project = u"FD.io CSIT" +copyright = u"2021, 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 @@ -71,7 +66,7 @@ author = u'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 = None +language = u'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -85,7 +80,7 @@ language = None # 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 reST default role (used for this markup: `text`) to use for all # documents. @@ -107,13 +102,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False +pygments_style = u"sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -124,31 +113,39 @@ 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 = 'alabaster' -html_theme = 'sphinx_rtd_theme' +# html_theme =u"alabaster" +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 = {} +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, + # Toc options + 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 themes here, relative to this directory. -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'] # The name for this set of Sphinx documents. # " v documentation" by default. # -html_title = u'CSIT Documentation' +html_title = u"CSIT Documentation" # A shorter title for the navigation bar. Default is the same as html_title. # -html_short_title = u'CSIT' - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# -html_logo = 'fdio_logo.png' +html_short_title = u"CSIT" # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 @@ -159,7 +156,7 @@ html_logo = 'fdio_logo.png' # 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_static_path = ['_static'] +html_static_path = [u"_static"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -190,58 +187,19 @@ html_static_path = ['_static'] # html_additional_pages = {} # If false, no module index is generated. -# -# html_domain_indices = True +html_domain_indices = True # If false, no index is generated. -# -# html_use_index = True +html_use_index = True # If true, the index is split into individual pages for each letter. -# html_split_index = False # If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' -# -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# 'ja' uses this config value. -# 'zh' user can custom change `jieba` dictionary path. -# -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# -# html_search_scorer = 'scorer.js' - # Output file base name for HTML help builder. -htmlhelp_basename = 'csitdoc' +htmlhelp_basename = u"csitdoc" # -- Options for LaTeX output --------------------------------------------- @@ -267,8 +225,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'CSIT.tex', u'CSIT Documentation', - u'CSIT', 'manual'), + (master_doc, u"CSIT.tex", u"CSIT Documentation", u"CSIT", u"manual"), ] # The name of an image file (relative to this directory) to place at the top of @@ -309,8 +266,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'CSIT', u'CSIT Documentation', - [author], 1) + (master_doc, u"CSIT", u"CSIT Documentation", [author], 1) ] # If true, show URL addresses after external links. @@ -324,9 +280,9 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'CSIT', u'CSIT Documentation', - author, 'CSIT', 'One line description of project.', - 'Miscellaneous'), + (master_doc, u"CSIT", u"CSIT Documentation", + author, u"CSIT", u"One line description of project.", + u"Miscellaneous"), ] # Documents to append as an appendix to all manuals.