diff options
Diffstat (limited to 'resources/tools/doc_gen/src/conf.py')
| -rw-r--r-- | resources/tools/doc_gen/src/conf.py | 56 |
1 files changed, 27 insertions, 29 deletions
diff --git a/resources/tools/doc_gen/src/conf.py b/resources/tools/doc_gen/src/conf.py index 1ebbbe7921..9be0baea53 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,31 @@ 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' +# source_suffix = [u".rst", u".md"] +source_suffix = u".rst" # The encoding of source files. # # source_encoding = 'utf-8-sig' # 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"CSIT" +copyright = u"2018, FD.io" +author = u"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 @@ -85,7 +85,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,7 +107,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = u"sphinx" # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] @@ -124,8 +124,8 @@ 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 @@ -134,21 +134,21 @@ html_theme = 'sphinx_rtd_theme' # html_theme_options = {} # 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/python2.7/site-packages/sphinx_rtd_theme"] # The name for this set of Sphinx documents. # "<project> v<release> 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' +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_logo = u"fdio_logo.png" # 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 +159,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 @@ -241,7 +241,7 @@ html_show_sourcelink = True # 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 +267,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 +308,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 +322,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. |