diff --git a/docs/conf.py b/docs/conf.py index 6547b5c..77d884f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,14 +19,14 @@ # -- Project information ----------------------------------------------------- -project = 'Little Boxes' -copyright = '2018, Thomas Sileo' -author = 'Thomas Sileo' +project = "Little Boxes" +copyright = "2018, Thomas Sileo" +author = "Thomas Sileo" # The short X.Y version -version = '' +version = "" # The full version, including alpha/beta/rc tags -release = '' +release = "" # -- General configuration --------------------------------------------------- @@ -38,22 +38,19 @@ release = '' # 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.viewcode', -] +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] # 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 master toctree document. -master_doc = 'index' +master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -65,10 +62,10 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path . -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # -- Options for HTML output ------------------------------------------------- @@ -76,7 +73,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = "alabaster" # 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 @@ -87,7 +84,7 @@ html_theme = 'alabaster' # 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 = ["_static"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -103,7 +100,7 @@ html_static_path = ['_static'] # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'LittleBoxesdoc' +htmlhelp_basename = "LittleBoxesdoc" # -- Options for LaTeX output ------------------------------------------------ @@ -112,15 +109,12 @@ 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', @@ -130,8 +124,13 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'LittleBoxes.tex', 'Little Boxes Documentation', - 'Thomas Sileo', 'manual'), + ( + master_doc, + "LittleBoxes.tex", + "Little Boxes Documentation", + "Thomas Sileo", + "manual", + ) ] @@ -139,10 +138,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'littleboxes', 'Little Boxes Documentation', - [author], 1) -] +man_pages = [(master_doc, "littleboxes", "Little Boxes Documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------------- @@ -151,10 +147,16 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'LittleBoxes', 'Little Boxes Documentation', - author, 'LittleBoxes', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "LittleBoxes", + "Little Boxes Documentation", + author, + "LittleBoxes", + "One line description of project.", + "Miscellaneous", + ) ] -# -- Extension configuration ------------------------------------------------- \ No newline at end of file +# -- Extension configuration -------------------------------------------------