diff options
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 79 |
1 files changed, 37 insertions, 42 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 269053675..076bfde53 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,7 +21,7 @@ import os import sys from buildstream import __version__ -sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -32,32 +32,28 @@ 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 = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.napoleon', - 'sphinx_click.ext' -] +extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_click.ext"] # Add any paths that contain templates here, relative to this directory. -templates_path = ['.templates'] +templates_path = [".templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. # # source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = 'BuildStream' -copyright = '2017-2018, The BuildStream Contributors' -author = 'The BuildStream Contributors' +project = "BuildStream" +copyright = "2017-2018, The BuildStream Contributors" # pylint: disable=redefined-builtin +author = "The BuildStream Contributors" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -109,10 +105,10 @@ add_module_names = False # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -modindex_common_prefix = ['buildstream.'] +modindex_common_prefix = ["buildstream."] # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False @@ -126,7 +122,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 = "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 @@ -160,7 +156,7 @@ 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_static_path = ['badges', 'images'] +html_static_path = ["badges", "images"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -240,34 +236,30 @@ html_static_path = ['badges', 'images'] # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'BuildStreamdoc' +htmlhelp_basename = "BuildStreamdoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'BuildStream.tex', 'BuildStream Documentation', - 'The BuildStream Contributors', 'manual'), + (master_doc, "BuildStream.tex", "BuildStream Documentation", "The BuildStream Contributors", "manual"), ] # The name of an image file (relative to this directory) to place at the top of @@ -307,10 +299,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'buildstream', 'BuildStream Documentation', - [author], 1) -] +man_pages = [(master_doc, "buildstream", "BuildStream Documentation", [author], 1)] # If true, show URL addresses after external links. # @@ -323,9 +312,15 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'BuildStream', 'BuildStream Documentation', - author, 'BuildStream', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "BuildStream", + "BuildStream Documentation", + author, + "BuildStream", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. @@ -344,4 +339,4 @@ texinfo_documents = [ # # texinfo_no_detailmenu = False -autodoc_member_order = 'bysource' +autodoc_member_order = "bysource" |