Update quotes in docs conf

This commit is contained in:
Roman Mogylatov 2021-09-30 20:13:26 -04:00
parent 8ade2b7839
commit 4f977c7cf0
2 changed files with 63 additions and 63 deletions

View File

@ -20,49 +20,49 @@ import alabaster
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath(".."))
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0' #needs_sphinx = "1.0"
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named "sphinx.ext.*") or your custom
# ones. # ones.
extensions = [ extensions = [
'alabaster', "alabaster",
'sphinx.ext.autodoc', "sphinx.ext.autodoc",
'sphinxcontrib.disqus', "sphinxcontrib.disqus",
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ["_templates"]
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md'] # source_suffix = [".rst", ".md"]
source_suffix = '.rst' source_suffix = ".rst"
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' #source_encoding = "utf-8-sig"
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = "index"
# General information about the project. # General information about the project.
project = u'Dependency Injector' project = "Dependency Injector"
copyright = u'2021, Roman Mogylatov' copyright = "2021, Roman Mogylatov"
author = u'Roman Mogylatov' author = "Roman Mogylatov"
# The version info for the project you're documenting, acts as replacement for # The version info for the project you"re documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
# Getting version: # Getting version:
with open('../src/dependency_injector/__init__.py') as init_file: with open("../src/dependency_injector/__init__.py") as init_file:
version = re.search('__version__ = \'(.*?)\'', init_file.read()).group(1) version = re.search("__version__ = \"(.*?)\"", init_file.read()).group(1)
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = version release = version
@ -76,19 +76,19 @@ language = None
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used:
#today = '' #today = ""
# Else, today_fmt is used as the format for a strftime call. # Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y' #today_fmt = "%B %d, %Y"
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ['_build'] exclude_patterns = ["_build"]
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
#default_role = None #default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, "()" will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True #add_function_parentheses = True
# If true, the current module name will be prepended to all description # If true, the current module name will be prepended to all description
@ -100,7 +100,7 @@ exclude_patterns = ['_build']
#show_authors = False #show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # 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. # A list of ignored prefixes for module index sorting.
#modindex_common_prefix = [] #modindex_common_prefix = []
@ -116,8 +116,8 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# html_theme = 'sphinx_rtd_theme' # html_theme = "sphinx_rtd_theme"
html_theme = 'alabaster' html_theme = "alabaster"
# Theme options are theme-specific and customize the look and feel of a 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 # further. For a list of options available for each theme, see the
@ -141,21 +141,21 @@ html_theme_path = [alabaster.get_path()]
# The name of an image file (within the static path) to use as favicon of the # The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large. # pixels large.
html_favicon = 'favicon.ico' html_favicon = "favicon.ico"
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # 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 # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation. # directly to the root of the documentation.
#html_extra_path = [] #html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not "", a "Last updated on:" timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
#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 # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
@ -189,50 +189,50 @@ html_static_path = ['_static']
# If true, an OpenSearch description file will be output, and all pages will # If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the # contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served. # base URL from which the finished HTML is served.
#html_use_opensearch = '' #html_use_opensearch = ""
# This is the file name suffix for HTML files (e.g. ".xhtml"). # This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None #html_file_suffix = None
# Language to be used for generating the HTML full-text search index. # Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages: # Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # "da", "de", "en", "es", "fi", "fr", "hu", "it", "ja"
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' # "nl", "no", "pt", "ro", "ru", "sv", "tr"
#html_search_language = 'en' #html_search_language = "en"
# A dictionary with options for the search language support, empty by default. # A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value # Now only "ja" uses this config value
#html_search_options = {'type': 'default'} #html_search_options = {"type": "default"}
# The name of a javascript file (relative to the configuration directory) that # The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used. # implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js' #html_search_scorer = "scorer.js"
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'dependency_injectordoc' htmlhelp_basename = "dependency_injectordoc"
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ("letterpaper" or "a4paper").
#'papersize': 'letterpaper', #"papersize": "letterpaper",
# The font size ('10pt', '11pt' or '12pt'). # The font size ("10pt", "11pt" or "12pt").
#'pointsize': '10pt', #"pointsize": "10pt",
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
#'preamble': '', #"preamble": "",
# Latex figure (float) alignment # Latex figure (float) alignment
#'figure_align': 'htbp', #"figure_align": "htbp",
} }
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'dependency_injector.tex', u'Dependency Injector Documentation', (master_doc, "dependency_injector.tex", u"Dependency Injector Documentation",
u'Roman Mogylatov', 'manual'), u"Roman Mogylatov", "manual"),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@ -261,7 +261,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'Dependency Injector', u'Dependency Injector Documentation', (master_doc, "Dependency Injector", u"Dependency Injector Documentation",
[author], 1) [author], 1)
] ]
@ -275,9 +275,9 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'Dependency Injector', u'Dependency Injector Documentation', (master_doc, "Dependency Injector", u"Dependency Injector Documentation",
author, 'Dependency Injector', 'Dependency injection microframework for Python', author, "Dependency Injector", "Dependency injection microframework for Python",
'Miscellaneous'), "Miscellaneous"),
] ]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
@ -286,24 +286,24 @@ texinfo_documents = [
# If false, no module index is generated. # If false, no module index is generated.
#texinfo_domain_indices = True #texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'. # How to display URL addresses: "footnote", "no", or "inline".
#texinfo_show_urls = 'footnote' #texinfo_show_urls = "footnote"
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node"s menu.
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
autodoc_member_order = 'bysource' autodoc_member_order = "bysource"
disqus_shortname = 'python-dependency-injector' disqus_shortname = "python-dependency-injector"
html_theme_options = { html_theme_options = {
'github_user': 'ets-labs', "github_user": "ets-labs",
'github_repo': 'python-dependency-injector', "github_repo": "python-dependency-injector",
'github_type': 'star', "github_type": "star",
'github_button': True, "github_button": True,
'github_banner': True, "github_banner": True,
'logo': 'logo.svg', "logo": "logo.svg",
'description': 'Dependency injection framework for Python by Roman Mogylatov', "description": "Dependency injection framework for Python by Roman Mogylatov",
'code_font_size': '10pt', "code_font_size": "10pt",
'analytics_id': 'UA-67012059-1', "analytics_id": "UA-67012059-1",
} }

View File

@ -1,6 +1,6 @@
"""Top-level package.""" """Top-level package."""
__version__ = '4.36.2' __version__ = "4.36.2"
"""Version number. """Version number.
:type: str :type: str