diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index aafcb253..edd4d190 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -13,17 +13,18 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # import os + # import sys # sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- -project = 'Freedom Metal' -copyright = '2019, SiFive Inc.' -author = 'SiFive Inc.' +project = "Freedom Metal" +copyright = "2019, SiFive Inc." +author = "SiFive Inc." -version = os.environ['RELEASE_TAG'] +version = os.environ["RELEASE_TAG"] release = version @@ -36,26 +37,23 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ - "breathe", - "sphinx.ext.graphviz" -] +extensions = ["breathe", "sphinx.ext.graphviz"] breathe_projects = { - "metal" : "../xml/", + "metal": "../xml/", } # Add any paths that contain templates here, relative to this directory. -templates_path = ['metal_templates'] +templates_path = ["metal_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. @@ -70,7 +68,7 @@ exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # This tells Sphinx to ignore the `__inline__` function attribute, fixing # errors related to parsing the function signature of functions marked `__inline__`. @@ -82,7 +80,7 @@ # 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 @@ -93,7 +91,7 @@ # 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 = ['metal_static'] +html_static_path = ["metal_static"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -104,13 +102,15 @@ # 'searchbox.html']``. # # html_sidebars = {} -html_sidebars = { '**': ['about.html', 'navigation.html', 'relations.html', 'searchbox.html']} +html_sidebars = { + "**": ["about.html", "navigation.html", "relations.html", "searchbox.html"] +} # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'FreedomMetaldoc' +htmlhelp_basename = "FreedomMetaldoc" # -- Options for LaTeX output ------------------------------------------------ @@ -119,15 +119,12 @@ # 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', @@ -137,8 +134,13 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'FreedomMetal.tex', 'Freedom Metal Documentation', - 'SiFive Inc.', 'manual'), + ( + master_doc, + "FreedomMetal.tex", + "Freedom Metal Documentation", + "SiFive Inc.", + "manual", + ), ] @@ -146,10 +148,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'freedommetal', 'Freedom Metal Documentation', - [author], 1) -] +man_pages = [(master_doc, "freedommetal", "Freedom Metal Documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------------- @@ -158,7 +157,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'FreedomMetal', 'Freedom Metal Documentation', - author, 'FreedomMetal', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "FreedomMetal", + "Freedom Metal Documentation", + author, + "FreedomMetal", + "One line description of project.", + "Miscellaneous", + ), ]