diff options
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 102 |
1 files changed, 54 insertions, 48 deletions
diff --git a/docs/conf.py b/docs/conf.py index 73a59d8..d6e0d79 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- # # pyfakefs documentation build configuration file, created by # sphinx-quickstart on Mon Oct 31 20:05:53 2016. @@ -20,8 +19,7 @@ import os import sys -sys.path.insert( - 0, os.path.split(os.path.dirname(os.path.abspath(__file__)))[0]) +sys.path.insert(0, os.path.split(os.path.dirname(os.path.abspath(__file__)))[0]) # -- General configuration ------------------------------------------------ @@ -33,49 +31,49 @@ sys.path.insert( # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.githubpages', # puts .nojekyll file into source - 'sphinx.ext.napoleon' # enables google style docstrings + "sphinx.ext.autodoc", + "sphinx.ext.githubpages", # puts .nojekyll file into source + "sphinx.ext.napoleon", # enables google style docstrings ] # 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 = 'pyfakefs' -copyright = '''2009 Google Inc. All Rights Reserved. +project = "pyfakefs" +copyright = """2009 Google Inc. All Rights Reserved. © Copyright 2014 Altera Corporation. All Rights Reserved. -© Copyright 2014-2021 John McGehee''' -author = 'John McGehee' +© Copyright 2014-2023 John McGehee""" +author = "John McGehee" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '4.6' +version = "5.3" # The full version, including alpha/beta/rc tags. -release = '4.6.dev0' +release = "5.3.dev0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # 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 = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -89,7 +87,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 = ["_build", "Thumbs.db", ".DS_Store"] # The reST default role (used for this markup: `text`) to use for all # documents. # @@ -109,12 +107,12 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # # show_authors = False -autoclass_content = 'both' +autoclass_content = "both" -autodoc_member_order = 'bysource' +autodoc_member_order = "bysource" # 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 = [] @@ -130,7 +128,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 = 'pyfakefs_theme' +html_theme = "pyfakefs_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 @@ -139,7 +137,7 @@ html_theme = 'pyfakefs_theme' # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['.'] +html_theme_path = ["."] # The name for this set of Sphinx documents. # "<project> v<release> documentation" by default. @@ -176,7 +174,7 @@ html_static_path = [] # bottom, using the given strftime format. # The empty string is equivalent to '%b %d, %Y'. # -html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = "%b %d, %Y" # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -244,33 +242,38 @@ html_show_sphinx = False # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'pyfakefsdoc' +htmlhelp_basename = "pyfakefsdoc" # -- 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, 'pyfakefs.tex', 'pyfakefs Documentation', - 'John McGehee', 'manual'), + ( + master_doc, + "pyfakefs.tex", + "pyfakefs Documentation", + "John McGehee", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of @@ -310,10 +313,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'pyfakefs', 'pyfakefs Documentation', - [author], 1) -] +man_pages = [(master_doc, "pyfakefs", "pyfakefs Documentation", [author], 1)] # If true, show URL addresses after external links. # @@ -326,9 +326,15 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'pyfakefs', 'pyfakefs Documentation', - author, 'pyfakefs', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "pyfakefs", + "pyfakefs Documentation", + author, + "pyfakefs", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. |