summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorJon Dufresne <jon.dufresne@gmail.com>2019-10-31 21:10:28 -0700
committerPaul McGuire <ptmcg@users.noreply.github.com>2019-10-31 23:10:28 -0500
commit53d1b4a6f48a53c4c4ec4ac7031362b691c0366d (patch)
tree088ad3cf3561b78a00af4fb2fd474f4a2b8ca70c /docs/conf.py
parent41752aa52cc97c710474bb2972cceab057b52ad4 (diff)
downloadpyparsing-git-53d1b4a6f48a53c4c4ec4ac7031362b691c0366d.tar.gz
Blacken the project (#141)
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py56
1 files changed, 31 insertions, 25 deletions
diff --git a/docs/conf.py b/docs/conf.py
index c4a7698..a26ed9b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,15 +13,16 @@
#
import os
import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
from pyparsing import __version__ as pyparsing_version
# -- Project information -----------------------------------------------------
-project = 'PyParsing'
-copyright = '2018, Paul T. McGuire'
-author = 'Paul T. McGuire'
+project = "PyParsing"
+copyright = "2018, Paul T. McGuire"
+author = "Paul T. McGuire"
# The short X.Y version
version = pyparsing_version
@@ -39,20 +40,20 @@ release = pyparsing_version
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'sphinx.ext.autodoc',
+ "sphinx.ext.autodoc",
]
# 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.
@@ -67,7 +68,7 @@ language = None
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
# -- Options for HTML output -------------------------------------------------
@@ -75,7 +76,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
@@ -86,7 +87,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.
@@ -102,7 +103,7 @@ html_static_path = ['_static']
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
-htmlhelp_basename = 'PyParsingdoc'
+htmlhelp_basename = "PyParsingdoc"
# -- Options for LaTeX output ------------------------------------------------
@@ -111,15 +112,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',
@@ -129,8 +127,13 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'PyParsing.tex', 'PyParsing Documentation',
- 'Paul T. McGuire', 'manual'),
+ (
+ master_doc,
+ "PyParsing.tex",
+ "PyParsing Documentation",
+ "Paul T. McGuire",
+ "manual",
+ ),
]
@@ -138,10 +141,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'pyparsing', 'PyParsing Documentation',
- [author], 1)
-]
+man_pages = [(master_doc, "pyparsing", "PyParsing Documentation", [author], 1)]
# -- Options for Texinfo output ----------------------------------------------
@@ -150,9 +150,15 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'PyParsing', 'PyParsing Documentation',
- author, 'PyParsing', 'One line description of project.',
- 'Miscellaneous'),
+ (
+ master_doc,
+ "PyParsing",
+ "PyParsing Documentation",
+ author,
+ "PyParsing",
+ "One line description of project.",
+ "Miscellaneous",
+ ),
]
@@ -174,7 +180,7 @@ epub_copyright = copyright
# epub_uid = ''
# A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
# -- Extension configuration -------------------------------------------------