summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoe Gordon <jogo@pinterest.com>2021-12-02 16:17:01 -0800
committerJoe Gordon <jogo@pinterest.com>2021-12-03 09:27:52 -0800
commit73c78212c0eea3970570cee48b55c3295b9f4c94 (patch)
tree563715d0eae29d06d642f266b5e1cd66d99b6b39 /docs
parentd43b10cbe4d35abf79fea816bdaafbd6c41f6c32 (diff)
downloadpymemcache-73c78212c0eea3970570cee48b55c3295b9f4c94.tar.gz
Apply black formatting
https://black.readthedocs.io/en/stable/index.html
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py101
1 files changed, 53 insertions, 48 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 5008ed2..b781a5a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -20,54 +20,54 @@ import os
import sys
import subprocess
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("."))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
-needs_sphinx = '3.0.0'
+needs_sphinx = "3.0.0"
# 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.intersphinx',
- 'sphinx.ext.napoleon',
- 'sphinx.ext.ifconfig',
- 'sphinxcontrib.apidoc',
+ "sphinx.ext.autodoc",
+ "sphinx.ext.intersphinx",
+ "sphinx.ext.napoleon",
+ "sphinx.ext.ifconfig",
+ "sphinxcontrib.apidoc",
]
# 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 = u'pymemcache'
-copyright = u'Pinterest'
-author = u'Charles Gordon, Jon Parise, Joe Gordon'
+project = "pymemcache"
+copyright = "Pinterest"
+author = "Charles Gordon, Jon Parise, Joe Gordon"
# 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 = u'3.2'
+version = "3.2"
# The full version, including alpha/beta/rc tags.
-release = u'3.2.0'
+release = "3.2.0"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -88,7 +88,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.
@@ -110,7 +110,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# 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 = []
@@ -127,7 +127,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
@@ -161,7 +161,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 = ['_static']
+html_static_path = ["_static"]
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
@@ -241,34 +241,36 @@ html_static_path = ['_static']
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
-htmlhelp_basename = 'pymemcachedoc'
+htmlhelp_basename = "pymemcachedoc"
# -- 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, 'pymemcache.tex', u'pymemcache Documentation',
- u'Charles Gordon, Jon Parise, Joe Gordon', 'manual'),
+ (
+ master_doc,
+ "pymemcache.tex",
+ "pymemcache Documentation",
+ "Charles Gordon, Jon Parise, Joe Gordon",
+ "manual",
+ ),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -308,10 +310,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'pymemcache', u'pymemcache Documentation',
- [author], 1)
-]
+man_pages = [(master_doc, "pymemcache", "pymemcache Documentation", [author], 1)]
# If true, show URL addresses after external links.
#
@@ -324,9 +323,15 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'pymemcache', u'pymemcache Documentation',
- author, 'pymemcache', 'One line description of project.',
- 'Miscellaneous'),
+ (
+ master_doc,
+ "pymemcache",
+ "pymemcache Documentation",
+ author,
+ "pymemcache",
+ "One line description of project.",
+ "Miscellaneous",
+ ),
]
# Documents to append as an appendix to all manuals.
@@ -347,11 +352,11 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}
# Automate building apidoc when building with readthedocs
-apidoc_module_dir = os.path.join('..', 'pymemcache')
-apidoc_output_dir = 'apidoc'
+apidoc_module_dir = os.path.join("..", "pymemcache")
+apidoc_output_dir = "apidoc"
apidoc_separate_modules = True
-apidoc_extra_args = ['--force']
+apidoc_extra_args = ["--force"]