From 4f977c7cf024b71f95007295530020fadd430cc3 Mon Sep 17 00:00:00 2001 From: Roman Mogylatov Date: Thu, 30 Sep 2021 20:13:26 -0400 Subject: [PATCH] Update quotes in docs conf --- docs/conf.py | 124 ++++++++++++++-------------- src/dependency_injector/__init__.py | 2 +- 2 files changed, 63 insertions(+), 63 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 58af81e8..fe6d6e19 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,49 +20,49 @@ import alabaster # 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 # 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 ------------------------------------------------ # 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 -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# extensions coming with Sphinx (named "sphinx.ext.*") or your custom # ones. extensions = [ - 'alabaster', - 'sphinx.ext.autodoc', - 'sphinxcontrib.disqus', + "alabaster", + "sphinx.ext.autodoc", + "sphinxcontrib.disqus", ] # 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", ".md"] +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +#source_encoding = "utf-8-sig" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Dependency Injector' -copyright = u'2021, Roman Mogylatov' -author = u'Roman Mogylatov' +project = "Dependency Injector" +copyright = "2021, 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 # built documents. # # The short X.Y version. # Getting version: -with open('../src/dependency_injector/__init__.py') as init_file: - version = re.search('__version__ = \'(.*?)\'', init_file.read()).group(1) +with open("../src/dependency_injector/__init__.py") as init_file: + version = re.search("__version__ = \"(.*?)\"", init_file.read()).group(1) # The full version, including alpha/beta/rc tags. release = version @@ -76,19 +76,19 @@ language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +#today = "" # 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 # 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 # documents. #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 # If true, the current module name will be prepended to all description @@ -100,7 +100,7 @@ exclude_patterns = ['_build'] #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 = [] @@ -116,8 +116,8 @@ 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 = 'alabaster' +# html_theme = "sphinx_rtd_theme" +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 @@ -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 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -html_favicon = 'favicon.ico' +html_favicon = "favicon.ico" # 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 # directly to the root of the documentation. #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. -#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. @@ -189,50 +189,50 @@ html_static_path = ['_static'] # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # 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"). #html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' +# "da", "de", "en", "es", "fi", "fr", "hu", "it", "ja" +# "nl", "no", "pt", "ro", "ru", "sv", "tr" +#html_search_language = "en" # A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} +# Now only "ja" uses this config value +#html_search_options = {"type": "default"} # The name of a javascript file (relative to the configuration directory) that # 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. -htmlhelp_basename = 'dependency_injectordoc' +htmlhelp_basename = "dependency_injectordoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', +# The paper size ("letterpaper" or "a4paper"). +#"papersize": "letterpaper", -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', +# The font size ("10pt", "11pt" or "12pt"). +#"pointsize": "10pt", # Additional stuff for the LaTeX preamble. -#'preamble': '', +#"preamble": "", # Latex figure (float) alignment -#'figure_align': 'htbp', +#"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, 'dependency_injector.tex', u'Dependency Injector Documentation', - u'Roman Mogylatov', 'manual'), + (master_doc, "dependency_injector.tex", u"Dependency Injector Documentation", + u"Roman Mogylatov", "manual"), ] # 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 # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'Dependency Injector', u'Dependency Injector Documentation', + (master_doc, "Dependency Injector", u"Dependency Injector Documentation", [author], 1) ] @@ -275,9 +275,9 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Dependency Injector', u'Dependency Injector Documentation', - author, 'Dependency Injector', 'Dependency injection microframework for Python', - 'Miscellaneous'), + (master_doc, "Dependency Injector", u"Dependency Injector Documentation", + author, "Dependency Injector", "Dependency injection microframework for Python", + "Miscellaneous"), ] # Documents to append as an appendix to all manuals. @@ -286,24 +286,24 @@ texinfo_documents = [ # If false, no module index is generated. #texinfo_domain_indices = True -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# How to display URL addresses: "footnote", "no", or "inline". +#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 -autodoc_member_order = 'bysource' +autodoc_member_order = "bysource" -disqus_shortname = 'python-dependency-injector' +disqus_shortname = "python-dependency-injector" html_theme_options = { - 'github_user': 'ets-labs', - 'github_repo': 'python-dependency-injector', - 'github_type': 'star', - 'github_button': True, - 'github_banner': True, - 'logo': 'logo.svg', - 'description': 'Dependency injection framework for Python by Roman Mogylatov', - 'code_font_size': '10pt', - 'analytics_id': 'UA-67012059-1', + "github_user": "ets-labs", + "github_repo": "python-dependency-injector", + "github_type": "star", + "github_button": True, + "github_banner": True, + "logo": "logo.svg", + "description": "Dependency injection framework for Python by Roman Mogylatov", + "code_font_size": "10pt", + "analytics_id": "UA-67012059-1", } diff --git a/src/dependency_injector/__init__.py b/src/dependency_injector/__init__.py index cdbb9c59..eecdfca5 100644 --- a/src/dependency_injector/__init__.py +++ b/src/dependency_injector/__init__.py @@ -1,6 +1,6 @@ """Top-level package.""" -__version__ = '4.36.2' +__version__ = "4.36.2" """Version number. :type: str