From 6b8bccec5977f608f0b1e33f31a4888a2ea0d141 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sat, 19 Feb 2022 22:44:45 +0000 Subject: [PATCH 1/9] Remove module titles in docstrings --- sphinx/__init__.py | 3 --- sphinx/__main__.py | 3 --- sphinx/addnodes.py | 3 --- sphinx/application.py | 3 --- sphinx/builders/__init__.py | 3 --- sphinx/builders/_epub_base.py | 3 --- sphinx/builders/changes.py | 3 --- sphinx/builders/dirhtml.py | 3 --- sphinx/builders/dummy.py | 3 --- sphinx/builders/epub3.py | 3 --- sphinx/builders/gettext.py | 3 --- sphinx/builders/html/__init__.py | 3 --- sphinx/builders/html/transforms.py | 3 --- sphinx/builders/latex/__init__.py | 3 --- sphinx/builders/latex/constants.py | 3 --- sphinx/builders/latex/nodes.py | 3 --- sphinx/builders/latex/theming.py | 3 --- sphinx/builders/latex/transforms.py | 3 --- sphinx/builders/latex/util.py | 3 --- sphinx/builders/linkcheck.py | 3 --- sphinx/builders/manpage.py | 3 --- sphinx/builders/singlehtml.py | 3 --- sphinx/builders/texinfo.py | 3 --- sphinx/builders/text.py | 3 --- sphinx/builders/xml.py | 3 --- sphinx/cmd/__init__.py | 3 --- sphinx/cmd/build.py | 3 --- sphinx/cmd/make_mode.py | 3 --- sphinx/cmd/quickstart.py | 3 --- sphinx/config.py | 3 --- sphinx/deprecation.py | 3 --- sphinx/directives/__init__.py | 3 --- sphinx/directives/code.py | 3 --- sphinx/directives/other.py | 3 --- sphinx/directives/patches.py | 3 --- sphinx/domains/__init__.py | 3 --- sphinx/domains/c.py | 3 --- sphinx/domains/changeset.py | 3 --- sphinx/domains/citation.py | 3 --- sphinx/domains/cpp.py | 3 --- sphinx/domains/index.py | 3 --- sphinx/domains/javascript.py | 3 --- sphinx/domains/math.py | 3 --- sphinx/domains/python.py | 3 --- sphinx/domains/rst.py | 3 --- sphinx/domains/std.py | 3 --- sphinx/environment/__init__.py | 3 --- sphinx/environment/adapters/__init__.py | 3 --- sphinx/environment/adapters/asset.py | 3 --- sphinx/environment/adapters/indexentries.py | 3 --- sphinx/environment/adapters/toctree.py | 3 --- sphinx/environment/collectors/__init__.py | 3 --- sphinx/environment/collectors/asset.py | 3 --- sphinx/environment/collectors/dependencies.py | 3 --- sphinx/environment/collectors/metadata.py | 3 --- sphinx/environment/collectors/title.py | 3 --- sphinx/environment/collectors/toctree.py | 3 --- sphinx/errors.py | 3 --- sphinx/events.py | 3 --- sphinx/ext/__init__.py | 3 --- sphinx/ext/apidoc.py | 3 --- sphinx/ext/autodoc/__init__.py | 3 --- sphinx/ext/autodoc/deprecated.py | 3 --- sphinx/ext/autodoc/directive.py | 3 --- sphinx/ext/autodoc/importer.py | 3 --- sphinx/ext/autodoc/mock.py | 3 --- sphinx/ext/autodoc/preserve_defaults.py | 3 --- sphinx/ext/autodoc/type_comment.py | 3 --- sphinx/ext/autodoc/typehints.py | 3 --- sphinx/ext/autosectionlabel.py | 3 --- sphinx/ext/autosummary/__init__.py | 3 --- sphinx/ext/autosummary/generate.py | 3 --- sphinx/ext/coverage.py | 3 --- sphinx/ext/doctest.py | 3 --- sphinx/ext/duration.py | 3 --- sphinx/ext/extlinks.py | 3 --- sphinx/ext/githubpages.py | 3 --- sphinx/ext/graphviz.py | 3 --- sphinx/ext/ifconfig.py | 3 --- sphinx/ext/imgconverter.py | 3 --- sphinx/ext/imgmath.py | 3 --- sphinx/ext/inheritance_diagram.py | 3 --- sphinx/ext/intersphinx.py | 3 --- sphinx/ext/linkcode.py | 3 --- sphinx/ext/mathjax.py | 3 --- sphinx/ext/napoleon/__init__.py | 3 --- sphinx/ext/napoleon/docstring.py | 3 --- sphinx/ext/napoleon/iterators.py | 3 --- sphinx/ext/todo.py | 3 --- sphinx/ext/viewcode.py | 3 --- sphinx/extension.py | 3 --- sphinx/highlighting.py | 3 --- sphinx/io.py | 3 --- sphinx/jinja2glue.py | 3 --- sphinx/locale/__init__.py | 3 --- sphinx/parsers.py | 3 --- sphinx/project.py | 3 --- sphinx/pycode/__init__.py | 3 --- sphinx/pycode/ast.py | 3 --- sphinx/pycode/parser.py | 3 --- sphinx/pygments_styles.py | 3 --- sphinx/registry.py | 3 --- sphinx/roles.py | 3 --- sphinx/search/__init__.py | 3 --- sphinx/search/da.py | 3 --- sphinx/search/de.py | 3 --- sphinx/search/en.py | 3 --- sphinx/search/es.py | 3 --- sphinx/search/fi.py | 3 --- sphinx/search/fr.py | 3 --- sphinx/search/hu.py | 3 --- sphinx/search/it.py | 3 --- sphinx/search/ja.py | 3 --- sphinx/search/jssplitter.py | 3 --- sphinx/search/nl.py | 3 --- sphinx/search/no.py | 3 --- sphinx/search/pt.py | 3 --- sphinx/search/ro.py | 3 --- sphinx/search/ru.py | 3 --- sphinx/search/sv.py | 3 --- sphinx/search/tr.py | 3 --- sphinx/search/zh.py | 3 --- sphinx/setup_command.py | 3 --- sphinx/testing/__init__.py | 3 --- sphinx/testing/comparer.py | 3 --- sphinx/testing/fixtures.py | 3 --- sphinx/testing/path.py | 3 --- sphinx/testing/restructuredtext.py | 3 --- sphinx/testing/util.py | 3 --- sphinx/theming.py | 3 --- sphinx/transforms/__init__.py | 3 --- sphinx/transforms/compact_bullet_list.py | 3 --- sphinx/transforms/i18n.py | 3 --- sphinx/transforms/post_transforms/__init__.py | 3 --- sphinx/transforms/post_transforms/code.py | 3 --- sphinx/transforms/post_transforms/images.py | 3 --- sphinx/transforms/references.py | 3 --- sphinx/util/__init__.py | 3 --- sphinx/util/build_phase.py | 3 --- sphinx/util/cfamily.py | 3 --- sphinx/util/compat.py | 3 --- sphinx/util/console.py | 3 --- sphinx/util/docfields.py | 3 --- sphinx/util/docstrings.py | 3 --- sphinx/util/docutils.py | 3 --- sphinx/util/fileutil.py | 3 --- sphinx/util/i18n.py | 3 --- sphinx/util/images.py | 3 --- sphinx/util/inspect.py | 3 --- sphinx/util/inventory.py | 3 --- sphinx/util/jsdump.py | 3 --- sphinx/util/logging.py | 3 --- sphinx/util/matching.py | 3 --- sphinx/util/math.py | 3 --- sphinx/util/nodes.py | 3 --- sphinx/util/osutil.py | 3 --- sphinx/util/parallel.py | 3 --- sphinx/util/png.py | 3 --- sphinx/util/pycompat.py | 3 --- sphinx/util/requests.py | 3 --- sphinx/util/rst.py | 3 --- sphinx/util/smartypants.py | 3 --- sphinx/util/stemmer/__init__.py | 3 --- sphinx/util/stemmer/porter.py | 3 --- sphinx/util/tags.py | 3 --- sphinx/util/template.py | 3 --- sphinx/util/texescape.py | 3 --- sphinx/util/typing.py | 3 --- sphinx/versioning.py | 3 --- sphinx/writers/__init__.py | 3 --- sphinx/writers/html.py | 3 --- sphinx/writers/html5.py | 3 --- sphinx/writers/latex.py | 3 --- sphinx/writers/manpage.py | 3 --- sphinx/writers/texinfo.py | 3 --- sphinx/writers/text.py | 3 --- sphinx/writers/xml.py | 3 --- tests/conftest.py | 3 --- tests/test_api_translator.py | 3 --- tests/test_application.py | 3 --- tests/test_build.py | 3 --- tests/test_build_changes.py | 3 --- tests/test_build_dirhtml.py | 3 --- tests/test_build_epub.py | 3 --- tests/test_build_gettext.py | 3 --- tests/test_build_html.py | 3 --- tests/test_build_latex.py | 3 --- tests/test_build_linkcheck.py | 3 --- tests/test_build_manpage.py | 3 --- tests/test_build_texinfo.py | 3 --- tests/test_build_text.py | 3 --- tests/test_builder.py | 3 --- tests/test_catalogs.py | 3 --- tests/test_config.py | 3 --- tests/test_correct_year.py | 3 --- tests/test_directive_code.py | 3 --- tests/test_directive_only.py | 3 --- tests/test_directive_other.py | 3 --- tests/test_directive_patch.py | 3 --- tests/test_docutilsconf.py | 3 --- tests/test_domain_c.py | 3 --- tests/test_domain_cpp.py | 3 --- tests/test_domain_js.py | 3 --- tests/test_domain_py.py | 3 --- tests/test_domain_rst.py | 3 --- tests/test_domain_std.py | 3 --- tests/test_environment.py | 3 --- tests/test_environment_indexentries.py | 3 --- tests/test_environment_toctree.py | 3 --- tests/test_events.py | 3 --- tests/test_ext_apidoc.py | 3 --- tests/test_ext_autodoc.py | 3 --- tests/test_ext_autodoc_autoattribute.py | 3 --- tests/test_ext_autodoc_autoclass.py | 3 --- tests/test_ext_autodoc_autodata.py | 3 --- tests/test_ext_autodoc_autofunction.py | 3 --- tests/test_ext_autodoc_automodule.py | 3 --- tests/test_ext_autodoc_autoproperty.py | 3 --- tests/test_ext_autodoc_configs.py | 3 --- tests/test_ext_autodoc_events.py | 3 --- tests/test_ext_autodoc_mock.py | 3 --- tests/test_ext_autodoc_preserve_defaults.py | 3 --- tests/test_ext_autodoc_private_members.py | 3 --- tests/test_ext_autosectionlabel.py | 3 --- tests/test_ext_autosummary.py | 3 --- tests/test_ext_coverage.py | 3 --- tests/test_ext_doctest.py | 3 --- tests/test_ext_duration.py | 3 --- tests/test_ext_githubpages.py | 3 --- tests/test_ext_graphviz.py | 3 --- tests/test_ext_ifconfig.py | 3 --- tests/test_ext_imgconverter.py | 3 --- tests/test_ext_inheritance_diagram.py | 3 --- tests/test_ext_intersphinx.py | 3 --- tests/test_ext_math.py | 3 --- tests/test_ext_napoleon.py | 3 --- tests/test_ext_napoleon_docstring.py | 3 --- tests/test_ext_napoleon_iterators.py | 3 --- tests/test_ext_todo.py | 3 --- tests/test_ext_viewcode.py | 3 --- tests/test_extension.py | 3 --- tests/test_highlighting.py | 3 --- tests/test_intl.py | 3 --- tests/test_locale.py | 3 --- tests/test_markup.py | 3 --- tests/test_metadata.py | 3 --- tests/test_parser.py | 3 --- tests/test_project.py | 3 --- tests/test_pycode.py | 3 --- tests/test_pycode_ast.py | 3 --- tests/test_pycode_parser.py | 3 --- tests/test_quickstart.py | 3 --- tests/test_roles.py | 3 --- tests/test_search.py | 3 --- tests/test_setup_command.py | 3 --- tests/test_smartquotes.py | 3 --- tests/test_templating.py | 3 --- tests/test_theming.py | 3 --- tests/test_toctree.py | 3 --- tests/test_transforms_post_transforms.py | 3 --- tests/test_transforms_post_transforms_code.py | 3 --- tests/test_util.py | 3 --- tests/test_util_docstrings.py | 3 --- tests/test_util_docutils.py | 3 --- tests/test_util_fileutil.py | 3 --- tests/test_util_i18n.py | 3 --- tests/test_util_images.py | 3 --- tests/test_util_inspect.py | 3 --- tests/test_util_inventory.py | 3 --- tests/test_util_logging.py | 3 --- tests/test_util_matching.py | 3 --- tests/test_util_nodes.py | 3 --- tests/test_util_rst.py | 3 --- tests/test_util_template.py | 3 --- tests/test_util_typing.py | 3 --- tests/test_versioning.py | 3 --- tests/test_writer_latex.py | 3 --- utils/checks.py | 3 --- utils/doclinter.py | 3 --- utils/jssplitter_generator.py | 3 --- 280 files changed, 840 deletions(-) diff --git a/sphinx/__init__.py b/sphinx/__init__.py index 8106e63bf..197d678c9 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -1,7 +1,4 @@ """ - Sphinx - ~~~~~~ - The Sphinx documentation toolchain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/__main__.py b/sphinx/__main__.py index daff05441..2d750a0c2 100644 --- a/sphinx/__main__.py +++ b/sphinx/__main__.py @@ -1,7 +1,4 @@ """ - sphinx.__main__ - ~~~~~~~~~~~~~~~ - The Sphinx documentation toolchain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index af1c8fff2..5f0ea74ee 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -1,7 +1,4 @@ """ - sphinx.addnodes - ~~~~~~~~~~~~~~~ - Additional docutils nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/application.py b/sphinx/application.py index fd8b65b6e..640c14e4e 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -1,7 +1,4 @@ """ - sphinx.application - ~~~~~~~~~~~~~~~~~~ - Sphinx application class and extensibility interface. Gracefully adapted from the TextPress system by Armin. diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index b61cd026d..0fd3649a2 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.builders - ~~~~~~~~~~~~~~~ - Builder superclass for all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index 3b1891769..1bdaf39ea 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -1,7 +1,4 @@ """ - sphinx.builders._epub_base - ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Base class of epub2/epub3 builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index a80e53d9a..84ea55f0d 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -1,7 +1,4 @@ """ - sphinx.builders.changes - ~~~~~~~~~~~~~~~~~~~~~~~ - Changelog builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/dirhtml.py b/sphinx/builders/dirhtml.py index 82af09be1..5e9218d3f 100644 --- a/sphinx/builders/dirhtml.py +++ b/sphinx/builders/dirhtml.py @@ -1,7 +1,4 @@ """ - sphinx.builders.dirhtml - ~~~~~~~~~~~~~~~~~~~~~~~ - Directory HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/dummy.py b/sphinx/builders/dummy.py index cddf8e7b8..083bde2f9 100644 --- a/sphinx/builders/dummy.py +++ b/sphinx/builders/dummy.py @@ -1,7 +1,4 @@ """ - sphinx.builders.dummy - ~~~~~~~~~~~~~~~~~~~~~ - Do syntax checks, but no writing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/epub3.py b/sphinx/builders/epub3.py index b1a3f520e..9f204db2c 100644 --- a/sphinx/builders/epub3.py +++ b/sphinx/builders/epub3.py @@ -1,7 +1,4 @@ """ - sphinx.builders.epub3 - ~~~~~~~~~~~~~~~~~~~~~ - Build epub3 files. Originally derived from epub.py. diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index f9dac2891..d07a89575 100644 --- a/sphinx/builders/gettext.py +++ b/sphinx/builders/gettext.py @@ -1,7 +1,4 @@ """ - sphinx.builders.gettext - ~~~~~~~~~~~~~~~~~~~~~~~ - The MessageCatalogBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py index 9f9c17b3d..e6c5ea5ae 100644 --- a/sphinx/builders/html/__init__.py +++ b/sphinx/builders/html/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.builders.html - ~~~~~~~~~~~~~~~~~~~~ - Several HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/html/transforms.py b/sphinx/builders/html/transforms.py index ea1d69d12..3f36c195d 100644 --- a/sphinx/builders/html/transforms.py +++ b/sphinx/builders/html/transforms.py @@ -1,7 +1,4 @@ """ - sphinx.builders.html.transforms - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Transforms for HTML builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index d7156b796..78063eee4 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.builders.latex - ~~~~~~~~~~~~~~~~~~~~~ - LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py index 25caf1736..1e939a46c 100644 --- a/sphinx/builders/latex/constants.py +++ b/sphinx/builders/latex/constants.py @@ -1,7 +1,4 @@ """ - sphinx.builders.latex.constants - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - consntants for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/latex/nodes.py b/sphinx/builders/latex/nodes.py index 95b5211f5..30c729941 100644 --- a/sphinx/builders/latex/nodes.py +++ b/sphinx/builders/latex/nodes.py @@ -1,7 +1,4 @@ """ - sphinx.builders.latex.nodes - ~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Additional nodes for LaTeX writer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/latex/theming.py b/sphinx/builders/latex/theming.py index b2e3a4dff..a465cb209 100644 --- a/sphinx/builders/latex/theming.py +++ b/sphinx/builders/latex/theming.py @@ -1,7 +1,4 @@ """ - sphinx.builders.latex.theming - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Theming support for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py index 621c6a7cf..3309b891d 100644 --- a/sphinx/builders/latex/transforms.py +++ b/sphinx/builders/latex/transforms.py @@ -1,7 +1,4 @@ """ - sphinx.builders.latex.transforms - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Transforms for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/latex/util.py b/sphinx/builders/latex/util.py index 6b797c9a2..da1f79653 100644 --- a/sphinx/builders/latex/util.py +++ b/sphinx/builders/latex/util.py @@ -1,7 +1,4 @@ """ - sphinx.builders.latex.util - ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Utilities for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index 4f760b8bc..e6621a254 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -1,7 +1,4 @@ """ - sphinx.builders.linkcheck - ~~~~~~~~~~~~~~~~~~~~~~~~~ - The CheckExternalLinksBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index c942cfa86..59870809e 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -1,7 +1,4 @@ """ - sphinx.builders.manpage - ~~~~~~~~~~~~~~~~~~~~~~~ - Manual pages builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py index 09db8d2b9..0c4daf8a4 100644 --- a/sphinx/builders/singlehtml.py +++ b/sphinx/builders/singlehtml.py @@ -1,7 +1,4 @@ """ - sphinx.builders.singlehtml - ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Single HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index f07cd2516..56448b638 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -1,7 +1,4 @@ """ - sphinx.builders.texinfo - ~~~~~~~~~~~~~~~~~~~~~~~ - Texinfo builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index 6363e11a0..038ae4ba0 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -1,7 +1,4 @@ """ - sphinx.builders.text - ~~~~~~~~~~~~~~~~~~~~ - Plain-text Sphinx builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py index c4e066089..873cc34d5 100644 --- a/sphinx/builders/xml.py +++ b/sphinx/builders/xml.py @@ -1,7 +1,4 @@ """ - sphinx.builders.xml - ~~~~~~~~~~~~~~~~~~~ - Docutils-native XML and pseudo-XML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/cmd/__init__.py b/sphinx/cmd/__init__.py index d77014547..717893f69 100644 --- a/sphinx/cmd/__init__.py +++ b/sphinx/cmd/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.cmd - ~~~~~~~~~~ - Modules for command line executables. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index 8de24a364..e135cf385 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -1,7 +1,4 @@ """ - sphinx.cmd.build - ~~~~~~~~~~~~~~~~ - Build documentation from a provided source. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/cmd/make_mode.py b/sphinx/cmd/make_mode.py index cad0eeabb..a08b673ad 100644 --- a/sphinx/cmd/make_mode.py +++ b/sphinx/cmd/make_mode.py @@ -1,7 +1,4 @@ """ - sphinx.cmd.make_mode - ~~~~~~~~~~~~~~~~~~~~ - sphinx-build -M command-line handling. This replaces the old, platform-dependent and once-generated content diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index 01e7e3b16..c5e3ebb52 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -1,7 +1,4 @@ """ - sphinx.cmd.quickstart - ~~~~~~~~~~~~~~~~~~~~~ - Quickly setup documentation source to work with Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/config.py b/sphinx/config.py index 37ca06e1d..32daedcec 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -1,7 +1,4 @@ """ - sphinx.config - ~~~~~~~~~~~~~ - Build configuration file handling. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py index 5b95f8b99..10ff34658 100644 --- a/sphinx/deprecation.py +++ b/sphinx/deprecation.py @@ -1,7 +1,4 @@ """ - sphinx.deprecation - ~~~~~~~~~~~~~~~~~~ - Sphinx deprecation classes and utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index 90658a904..1b4a992b9 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.directives - ~~~~~~~~~~~~~~~~~ - Handlers for additional ReST directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/directives/code.py b/sphinx/directives/code.py index ddd47e1f8..971a42676 100644 --- a/sphinx/directives/code.py +++ b/sphinx/directives/code.py @@ -1,7 +1,4 @@ """ - sphinx.directives.code - ~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index a14b6e801..efd630262 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -1,7 +1,4 @@ """ - sphinx.directives.other - ~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/directives/patches.py b/sphinx/directives/patches.py index d76bb74c7..209b58893 100644 --- a/sphinx/directives/patches.py +++ b/sphinx/directives/patches.py @@ -1,7 +1,4 @@ """ - sphinx.directives.patches - ~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py index 4252baf65..6e702b86e 100644 --- a/sphinx/domains/__init__.py +++ b/sphinx/domains/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.domains - ~~~~~~~~~~~~~~ - Support for domains, which are groupings of description directives and roles describing e.g. constructs of one programming language. diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index 5181afb17..c79173e01 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -1,7 +1,4 @@ """ - sphinx.domains.c - ~~~~~~~~~~~~~~~~ - The C language domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index 9db598975..817f35487 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -1,7 +1,4 @@ """ - sphinx.domains.changeset - ~~~~~~~~~~~~~~~~~~~~~~~~ - The changeset domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/citation.py b/sphinx/domains/citation.py index f98abc4d1..a3b5bc04b 100644 --- a/sphinx/domains/citation.py +++ b/sphinx/domains/citation.py @@ -1,7 +1,4 @@ """ - sphinx.domains.citation - ~~~~~~~~~~~~~~~~~~~~~~~ - The citation domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 4f336a4bf..a9fe0d967 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1,7 +1,4 @@ """ - sphinx.domains.cpp - ~~~~~~~~~~~~~~~~~~ - The C++ language domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/index.py b/sphinx/domains/index.py index 7dbc1bb5a..961b590f4 100644 --- a/sphinx/domains/index.py +++ b/sphinx/domains/index.py @@ -1,7 +1,4 @@ """ - sphinx.domains.index - ~~~~~~~~~~~~~~~~~~~~ - The index domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 2095d1d10..5c30c2180 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -1,7 +1,4 @@ """ - sphinx.domains.javascript - ~~~~~~~~~~~~~~~~~~~~~~~~~ - The JavaScript domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py index 7f66a4738..f4db6a6b7 100644 --- a/sphinx/domains/math.py +++ b/sphinx/domains/math.py @@ -1,7 +1,4 @@ """ - sphinx.domains.math - ~~~~~~~~~~~~~~~~~~~ - The math domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index 145b62eda..e927b959d 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -1,7 +1,4 @@ """ - sphinx.domains.python - ~~~~~~~~~~~~~~~~~~~~~ - The Python domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py index 0899e02f8..40f69dee3 100644 --- a/sphinx/domains/rst.py +++ b/sphinx/domains/rst.py @@ -1,7 +1,4 @@ """ - sphinx.domains.rst - ~~~~~~~~~~~~~~~~~~ - The reStructuredText domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index e9f75325a..8187abd4b 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -1,7 +1,4 @@ """ - sphinx.domains.std - ~~~~~~~~~~~~~~~~~~ - The standard domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index 9dde7b407..bbe4bf2b7 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.environment - ~~~~~~~~~~~~~~~~~~ - Global creation environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/adapters/__init__.py b/sphinx/environment/adapters/__init__.py index 168bd6ba6..2fd847357 100644 --- a/sphinx/environment/adapters/__init__.py +++ b/sphinx/environment/adapters/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.environment.adapters - ~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Sphinx environment adapters :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/adapters/asset.py b/sphinx/environment/adapters/asset.py index af5f79e96..63e736ff7 100644 --- a/sphinx/environment/adapters/asset.py +++ b/sphinx/environment/adapters/asset.py @@ -1,7 +1,4 @@ """ - sphinx.environment.adapters.asset - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Assets adapter for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/adapters/indexentries.py b/sphinx/environment/adapters/indexentries.py index d13c24042..28d56e1c8 100644 --- a/sphinx/environment/adapters/indexentries.py +++ b/sphinx/environment/adapters/indexentries.py @@ -1,7 +1,4 @@ """ - sphinx.environment.adapters.indexentries - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Index entries adapters for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index 962e73143..1c27fa705 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/sphinx/environment/adapters/toctree.py @@ -1,7 +1,4 @@ """ - sphinx.environment.adapters.toctree - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Toctree adapter for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/collectors/__init__.py b/sphinx/environment/collectors/__init__.py index ba7c20636..badc0bac0 100644 --- a/sphinx/environment/collectors/__init__.py +++ b/sphinx/environment/collectors/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.environment.collectors - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The data collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/collectors/asset.py b/sphinx/environment/collectors/asset.py index 9530b3bd9..fd51061b9 100644 --- a/sphinx/environment/collectors/asset.py +++ b/sphinx/environment/collectors/asset.py @@ -1,7 +1,4 @@ """ - sphinx.environment.collectors.asset - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The image collector for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/collectors/dependencies.py b/sphinx/environment/collectors/dependencies.py index 4138c4c15..d1ce80a73 100644 --- a/sphinx/environment/collectors/dependencies.py +++ b/sphinx/environment/collectors/dependencies.py @@ -1,7 +1,4 @@ """ - sphinx.environment.collectors.dependencies - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The dependencies collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/collectors/metadata.py b/sphinx/environment/collectors/metadata.py index 3165b0389..34bfb49cd 100644 --- a/sphinx/environment/collectors/metadata.py +++ b/sphinx/environment/collectors/metadata.py @@ -1,7 +1,4 @@ """ - sphinx.environment.collectors.metadata - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The metadata collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/collectors/title.py b/sphinx/environment/collectors/title.py index 8c285f323..1ef53514d 100644 --- a/sphinx/environment/collectors/title.py +++ b/sphinx/environment/collectors/title.py @@ -1,7 +1,4 @@ """ - sphinx.environment.collectors.title - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The title collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/environment/collectors/toctree.py b/sphinx/environment/collectors/toctree.py index ddc7a0417..dc39ee254 100644 --- a/sphinx/environment/collectors/toctree.py +++ b/sphinx/environment/collectors/toctree.py @@ -1,7 +1,4 @@ """ - sphinx.environment.collectors.toctree - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Toctree collector for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/errors.py b/sphinx/errors.py index c90dd10d0..f89804c7f 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,7 +1,4 @@ """ - sphinx.errors - ~~~~~~~~~~~~~ - Contains SphinxError and a few subclasses (in an extra module to avoid circular import problems). diff --git a/sphinx/events.py b/sphinx/events.py index 46cea6827..5a95416fc 100644 --- a/sphinx/events.py +++ b/sphinx/events.py @@ -1,7 +1,4 @@ """ - sphinx.events - ~~~~~~~~~~~~~ - Sphinx core events. Gracefully adapted from the TextPress system by Armin. diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py index 803691ca3..a97bab5bf 100644 --- a/sphinx/ext/__init__.py +++ b/sphinx/ext/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.ext - ~~~~~~~~~~ - Contains Sphinx features not activated by default. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py index 07339d6e6..bb1e582eb 100644 --- a/sphinx/ext/apidoc.py +++ b/sphinx/ext/apidoc.py @@ -1,7 +1,4 @@ """ - sphinx.ext.apidoc - ~~~~~~~~~~~~~~~~~ - Parses a directory tree looking for Python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index (named modules.). diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index a6d36f61f..6d19e6eee 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autodoc - ~~~~~~~~~~~~~~~~~~ - Automatically insert docstrings for functions, classes or whole modules into the doctree, thus avoiding duplication between docstrings and documentation for those who like elaborate docstrings. diff --git a/sphinx/ext/autodoc/deprecated.py b/sphinx/ext/autodoc/deprecated.py index 22c9f46b6..63e2c307b 100644 --- a/sphinx/ext/autodoc/deprecated.py +++ b/sphinx/ext/autodoc/deprecated.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autodoc.deprecated - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The deprecated Documenters for autodoc. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index 0c040e1ef..a52f1c1a3 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autodoc.directive - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py index b1bf28ec8..dfa088f2a 100644 --- a/sphinx/ext/autodoc/importer.py +++ b/sphinx/ext/autodoc/importer.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autodoc.importer - ~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Importer utilities for autodoc :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py index 7bd0b1ea0..759c5bae1 100644 --- a/sphinx/ext/autodoc/mock.py +++ b/sphinx/ext/autodoc/mock.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autodoc.mock - ~~~~~~~~~~~~~~~~~~~~~~~ - mock for autodoc :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autodoc/preserve_defaults.py b/sphinx/ext/autodoc/preserve_defaults.py index 8ce16b37a..9b5d76204 100644 --- a/sphinx/ext/autodoc/preserve_defaults.py +++ b/sphinx/ext/autodoc/preserve_defaults.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autodoc.preserve_defaults - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Preserve the default argument values of function signatures in source code and keep them not evaluated for readability. diff --git a/sphinx/ext/autodoc/type_comment.py b/sphinx/ext/autodoc/type_comment.py index 95ba6f6b7..e4483842d 100644 --- a/sphinx/ext/autodoc/type_comment.py +++ b/sphinx/ext/autodoc/type_comment.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autodoc.type_comment - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Update annotations info of living objects using type_comments. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py index 6acd99e46..6b4188d22 100644 --- a/sphinx/ext/autodoc/typehints.py +++ b/sphinx/ext/autodoc/typehints.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autodoc.typehints - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Generating content for autodoc using typehints :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py index e8efcb076..944d2d4cc 100644 --- a/sphinx/ext/autosectionlabel.py +++ b/sphinx/ext/autosectionlabel.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autosectionlabel - ~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Allow reference sections by :ref: role using its title. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index 964c0f532..c18a71d70 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autosummary - ~~~~~~~~~~~~~~~~~~~~~~ - Sphinx extension that adds an autosummary:: directive, which can be used to generate function/method/attribute/etc. summary lists, similar to those output eg. by Epydoc and other API doc generation tools. diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index 236865630..ff67a25e8 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -1,7 +1,4 @@ """ - sphinx.ext.autosummary.generate - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Usable as a library or script to generate automatic RST source files for items referred to in autosummary:: directives. diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index 2a7e08f8b..652bc5c0f 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -1,7 +1,4 @@ """ - sphinx.ext.coverage - ~~~~~~~~~~~~~~~~~~~ - Check Python modules and C API for coverage. Mostly written by Josip Dzolonga for the Google Highly Open Participation contest. diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index 490516d63..af6da43e0 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -1,7 +1,4 @@ """ - sphinx.ext.doctest - ~~~~~~~~~~~~~~~~~~ - Mimic doctest by automatically executing code snippets and checking their results. diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py index b65703472..6e918b134 100644 --- a/sphinx/ext/duration.py +++ b/sphinx/ext/duration.py @@ -1,7 +1,4 @@ """ - sphinx.ext.duration - ~~~~~~~~~~~~~~~~~~~ - Measure durations of Sphinx processing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py index 8caba8842..58ed9674b 100644 --- a/sphinx/ext/extlinks.py +++ b/sphinx/ext/extlinks.py @@ -1,7 +1,4 @@ """ - sphinx.ext.extlinks - ~~~~~~~~~~~~~~~~~~~ - Extension to save typing and prevent hard-coding of base URLs in the reST files. diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py index 0ea25ba52..cb2584d8d 100644 --- a/sphinx/ext/githubpages.py +++ b/sphinx/ext/githubpages.py @@ -1,7 +1,4 @@ """ - sphinx.ext.githubpages - ~~~~~~~~~~~~~~~~~~~~~~ - To publish HTML docs at GitHub Pages, create .nojekyll file. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index ad248993d..e5749d143 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -1,7 +1,4 @@ """ - sphinx.ext.graphviz - ~~~~~~~~~~~~~~~~~~~ - Allow graphviz-formatted graphs to be included in Sphinx-generated documents inline. diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 50a2b203f..44f218f3d 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -1,7 +1,4 @@ """ - sphinx.ext.ifconfig - ~~~~~~~~~~~~~~~~~~~ - Provides the ``ifconfig`` directive that allows to write documentation that is included depending on configuration variables. diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index 5a1653037..2117e7130 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -1,7 +1,4 @@ """ - sphinx.ext.imgconverter - ~~~~~~~~~~~~~~~~~~~~~~~ - Image converter extension for Sphinx :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index 189bf8786..bdabc8634 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -1,7 +1,4 @@ """ - sphinx.ext.imgmath - ~~~~~~~~~~~~~~~~~~ - Render math in HTML via dvipng or dvisvgm. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index cf4626c0b..e1fd2a237 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -1,7 +1,4 @@ r""" - sphinx.ext.inheritance_diagram - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Defines a docutils directive for inserting inheritance diagrams. Provide the directive with one or more classes or modules (separated diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index 2f8ab2588..eacc72f85 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -1,7 +1,4 @@ """ - sphinx.ext.intersphinx - ~~~~~~~~~~~~~~~~~~~~~~ - Insert links to objects documented in remote Sphinx documentation. This works as follows: diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index 6ae828408..d724e3551 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -1,7 +1,4 @@ """ - sphinx.ext.linkcode - ~~~~~~~~~~~~~~~~~~~ - Add external links to module code in Python object descriptions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index 7b85799ec..c641b11ea 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -1,7 +1,4 @@ """ - sphinx.ext.mathjax - ~~~~~~~~~~~~~~~~~~ - Allow `MathJax `_ to be used to display math in Sphinx's HTML writer -- requires the MathJax JavaScript library on your webserver/computer. diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index 7f86b1745..07e165ec6 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.ext.napoleon - ~~~~~~~~~~~~~~~~~~~ - Support for NumPy and Google style docstrings. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index 9b9834cfa..cd68deeff 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -1,7 +1,4 @@ """ - sphinx.ext.napoleon.docstring - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Classes for docstring parsing and formatting. diff --git a/sphinx/ext/napoleon/iterators.py b/sphinx/ext/napoleon/iterators.py index f4d4c2423..b6e549f70 100644 --- a/sphinx/ext/napoleon/iterators.py +++ b/sphinx/ext/napoleon/iterators.py @@ -1,7 +1,4 @@ """ - sphinx.ext.napoleon.iterators - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - A collection of helpful iterators. diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index 3b8ba1924..7c1df2c69 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -1,7 +1,4 @@ """ - sphinx.ext.todo - ~~~~~~~~~~~~~~~ - Allow todos to be inserted into your documentation. Inclusion of todos can be switched of by a configuration variable. The todolist directive collects all todos of your project and lists them along with a backlink to the diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 54274ac04..5fd6120c0 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -1,7 +1,4 @@ """ - sphinx.ext.viewcode - ~~~~~~~~~~~~~~~~~~~ - Add links to module code in Python object descriptions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/extension.py b/sphinx/extension.py index 890a5d8a7..0188dab17 100644 --- a/sphinx/extension.py +++ b/sphinx/extension.py @@ -1,7 +1,4 @@ """ - sphinx.extension - ~~~~~~~~~~~~~~~~ - Utilities for Sphinx extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 200f41b33..37e1cdf17 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -1,7 +1,4 @@ """ - sphinx.highlighting - ~~~~~~~~~~~~~~~~~~~ - Highlight code blocks using Pygments. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/io.py b/sphinx/io.py index b52ce094f..7d8bd87a9 100644 --- a/sphinx/io.py +++ b/sphinx/io.py @@ -1,7 +1,4 @@ """ - sphinx.io - ~~~~~~~~~ - Input/Output files :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index 525a4a994..c61ad8cf8 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -1,7 +1,4 @@ """ - sphinx.jinja2glue - ~~~~~~~~~~~~~~~~~ - Glue code for the jinja2 templating engine. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py index 5378da0a3..b0e579d3b 100644 --- a/sphinx/locale/__init__.py +++ b/sphinx/locale/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.locale - ~~~~~~~~~~~~~ - Locale utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/parsers.py b/sphinx/parsers.py index 3204c0a1b..471c27274 100644 --- a/sphinx/parsers.py +++ b/sphinx/parsers.py @@ -1,7 +1,4 @@ """ - sphinx.parsers - ~~~~~~~~~~~~~~ - A Base class for additional parsers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/project.py b/sphinx/project.py index 156a08578..47559d7b8 100644 --- a/sphinx/project.py +++ b/sphinx/project.py @@ -1,7 +1,4 @@ """ - sphinx.project - ~~~~~~~~~~~~~~ - Utility function and classes for Sphinx projects. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index 681bfa38b..66f506795 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.pycode - ~~~~~~~~~~~~~ - Utilities parsing and analyzing Python code. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py index 9e1d23ccc..07c85bf11 100644 --- a/sphinx/pycode/ast.py +++ b/sphinx/pycode/ast.py @@ -1,7 +1,4 @@ """ - sphinx.pycode.ast - ~~~~~~~~~~~~~~~~~ - Helpers for AST (Abstract Syntax Tree). :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py index 5034fe9d5..2265dd2ac 100644 --- a/sphinx/pycode/parser.py +++ b/sphinx/pycode/parser.py @@ -1,7 +1,4 @@ """ - sphinx.pycode.parser - ~~~~~~~~~~~~~~~~~~~~ - Utilities parsing and analyzing Python code. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py index d81aa2879..37bd872bc 100644 --- a/sphinx/pygments_styles.py +++ b/sphinx/pygments_styles.py @@ -1,7 +1,4 @@ """ - sphinx.pygments_styles - ~~~~~~~~~~~~~~~~~~~~~~ - Sphinx theme specific highlighting styles. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/registry.py b/sphinx/registry.py index 76c30b905..e928bb4db 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -1,7 +1,4 @@ """ - sphinx.registry - ~~~~~~~~~~~~~~~ - Sphinx component registry. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/roles.py b/sphinx/roles.py index 09cfac9c7..177b7c61b 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -1,7 +1,4 @@ """ - sphinx.roles - ~~~~~~~~~~~~ - Handlers for additional ReST roles. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index 28f3ea036..c569aa797 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.search - ~~~~~~~~~~~~~ - Create a full-text search index for offline search. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/da.py b/sphinx/search/da.py index 6ef91b86f..275555136 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -1,7 +1,4 @@ """ - sphinx.search.da - ~~~~~~~~~~~~~~~~ - Danish search language: includes the JS Danish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/de.py b/sphinx/search/de.py index 58ea6942c..af02d12dd 100644 --- a/sphinx/search/de.py +++ b/sphinx/search/de.py @@ -1,7 +1,4 @@ """ - sphinx.search.de - ~~~~~~~~~~~~~~~~ - German search language: includes the JS German stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/en.py b/sphinx/search/en.py index 81ff1ae80..c6667c530 100644 --- a/sphinx/search/en.py +++ b/sphinx/search/en.py @@ -1,7 +1,4 @@ """ - sphinx.search.en - ~~~~~~~~~~~~~~~~ - English search language: includes the JS porter stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/es.py b/sphinx/search/es.py index 137a09063..3026c9fd4 100644 --- a/sphinx/search/es.py +++ b/sphinx/search/es.py @@ -1,7 +1,4 @@ """ - sphinx.search.es - ~~~~~~~~~~~~~~~~ - Spanish search language: includes the JS Spanish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py index 313ddd158..bda7159f0 100644 --- a/sphinx/search/fi.py +++ b/sphinx/search/fi.py @@ -1,7 +1,4 @@ """ - sphinx.search.fi - ~~~~~~~~~~~~~~~~ - Finnish search language: includes the JS Finnish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py index eea1fb507..4692a64e3 100644 --- a/sphinx/search/fr.py +++ b/sphinx/search/fr.py @@ -1,7 +1,4 @@ """ - sphinx.search.fr - ~~~~~~~~~~~~~~~~ - French search language: includes the JS French stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py index 365439d92..0d0c28e50 100644 --- a/sphinx/search/hu.py +++ b/sphinx/search/hu.py @@ -1,7 +1,4 @@ """ - sphinx.search.hu - ~~~~~~~~~~~~~~~~ - Hungarian search language: includes the JS Hungarian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/it.py b/sphinx/search/it.py index da042820f..9ec7768ed 100644 --- a/sphinx/search/it.py +++ b/sphinx/search/it.py @@ -1,7 +1,4 @@ """ - sphinx.search.it - ~~~~~~~~~~~~~~~~ - Italian search language: includes the JS Italian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index 1d5ebb605..820de07f1 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -1,7 +1,4 @@ """ - sphinx.search.ja - ~~~~~~~~~~~~~~~~ - Japanese search language: includes routine to split words. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/jssplitter.py b/sphinx/search/jssplitter.py index 4403347ed..13f55a16e 100644 --- a/sphinx/search/jssplitter.py +++ b/sphinx/search/jssplitter.py @@ -1,7 +1,4 @@ """ - sphinx.search.jssplitter - ~~~~~~~~~~~~~~~~~~~~~~~~ - Provides Python compatible word splitter to JavaScript DO NOT EDIT. This is generated by utils/jssplitter_generator.py diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py index 744c7f5d8..06c84ce4d 100644 --- a/sphinx/search/nl.py +++ b/sphinx/search/nl.py @@ -1,7 +1,4 @@ """ - sphinx.search.nl - ~~~~~~~~~~~~~~~~ - Dutch search language: includes the JS porter stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/no.py b/sphinx/search/no.py index bff65537f..1208991cb 100644 --- a/sphinx/search/no.py +++ b/sphinx/search/no.py @@ -1,7 +1,4 @@ """ - sphinx.search.no - ~~~~~~~~~~~~~~~~ - Norwegian search language: includes the JS Norwegian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py index 41c2e6004..46a4bb0d0 100644 --- a/sphinx/search/pt.py +++ b/sphinx/search/pt.py @@ -1,7 +1,4 @@ """ - sphinx.search.pt - ~~~~~~~~~~~~~~~~ - Portuguese search language: includes the JS Portuguese stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/ro.py b/sphinx/search/ro.py index 3736142d2..817c70165 100644 --- a/sphinx/search/ro.py +++ b/sphinx/search/ro.py @@ -1,7 +1,4 @@ """ - sphinx.search.ro - ~~~~~~~~~~~~~~~~ - Romanian search language: includes the JS Romanian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index b3c2990be..f2e027592 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -1,7 +1,4 @@ """ - sphinx.search.ru - ~~~~~~~~~~~~~~~~ - Russian search language: includes the JS Russian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py index 29d2764ef..c7b0fde93 100644 --- a/sphinx/search/sv.py +++ b/sphinx/search/sv.py @@ -1,7 +1,4 @@ """ - sphinx.search.sv - ~~~~~~~~~~~~~~~~ - Swedish search language: includes the JS Swedish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/tr.py b/sphinx/search/tr.py index 86075291c..c85912337 100644 --- a/sphinx/search/tr.py +++ b/sphinx/search/tr.py @@ -1,7 +1,4 @@ """ - sphinx.search.tr - ~~~~~~~~~~~~~~~~ - Turkish search language: includes the JS Turkish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/search/zh.py b/sphinx/search/zh.py index 0daa4af2a..276a49a70 100644 --- a/sphinx/search/zh.py +++ b/sphinx/search/zh.py @@ -1,7 +1,4 @@ """ - sphinx.search.zh - ~~~~~~~~~~~~~~~~ - Chinese search language: includes routine to split words. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index 67b89f1c8..3d9663d0f 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -1,7 +1,4 @@ """ - sphinx.setup_command - ~~~~~~~~~~~~~~~~~~~~ - Setuptools/distutils commands to assist the building of sphinx documentation. diff --git a/sphinx/testing/__init__.py b/sphinx/testing/__init__.py index c28c0ce0a..babfde1f5 100644 --- a/sphinx/testing/__init__.py +++ b/sphinx/testing/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.testing - ~~~~~~~~~~~~~~ - Sphinx test utilities You can require sphinx.testing pytest fixtures in a test module or a conftest diff --git a/sphinx/testing/comparer.py b/sphinx/testing/comparer.py index 395fe1f74..577a4d091 100644 --- a/sphinx/testing/comparer.py +++ b/sphinx/testing/comparer.py @@ -1,7 +1,4 @@ """ - sphinx.testing.comparer - ~~~~~~~~~~~~~~~~~~~~~~~ - Sphinx test comparer for pytest :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py index 317933ee7..69233707c 100644 --- a/sphinx/testing/fixtures.py +++ b/sphinx/testing/fixtures.py @@ -1,7 +1,4 @@ """ - sphinx.testing.fixtures - ~~~~~~~~~~~~~~~~~~~~~~~ - Sphinx test fixtures for pytest :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/testing/path.py b/sphinx/testing/path.py index ef3b5c7d0..984e0a01c 100644 --- a/sphinx/testing/path.py +++ b/sphinx/testing/path.py @@ -1,7 +1,4 @@ """ - sphinx.testing.path - ~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/testing/restructuredtext.py b/sphinx/testing/restructuredtext.py index 59dcd37aa..aa0ebb354 100644 --- a/sphinx/testing/restructuredtext.py +++ b/sphinx/testing/restructuredtext.py @@ -1,7 +1,4 @@ """ - sphinx.testing.restructuredtext - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py index d062612cb..197e802ed 100644 --- a/sphinx/testing/util.py +++ b/sphinx/testing/util.py @@ -1,7 +1,4 @@ """ - sphinx.testing.util - ~~~~~~~~~~~~~~~~~~~ - Sphinx test suite utilities :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/theming.py b/sphinx/theming.py index 819cec377..c4cfad77a 100644 --- a/sphinx/theming.py +++ b/sphinx/theming.py @@ -1,7 +1,4 @@ """ - sphinx.theming - ~~~~~~~~~~~~~~ - Theming support for HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py index 26e075a7a..ab23f7b4e 100644 --- a/sphinx/transforms/__init__.py +++ b/sphinx/transforms/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.transforms - ~~~~~~~~~~~~~~~~~ - Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py index e39ac97d1..c1dfee0d8 100644 --- a/sphinx/transforms/compact_bullet_list.py +++ b/sphinx/transforms/compact_bullet_list.py @@ -1,7 +1,4 @@ """ - sphinx.transforms.compact_bullet_list - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py index fb2824fe0..6a80daf08 100644 --- a/sphinx/transforms/i18n.py +++ b/sphinx/transforms/i18n.py @@ -1,7 +1,4 @@ """ - sphinx.transforms.i18n - ~~~~~~~~~~~~~~~~~~~~~~ - Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py index df2eeecbb..720807118 100644 --- a/sphinx/transforms/post_transforms/__init__.py +++ b/sphinx/transforms/post_transforms/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.transforms.post_transforms - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index 55bd56c2e..0deda5ed0 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -1,7 +1,4 @@ """ - sphinx.transforms.post_transforms.code - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - transforms for code-blocks. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py index 1a6d4f6d5..6c265a470 100644 --- a/sphinx/transforms/post_transforms/images.py +++ b/sphinx/transforms/post_transforms/images.py @@ -1,7 +1,4 @@ """ - sphinx.transforms.post_transforms.images - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py index 82e8043bb..b47fb545b 100644 --- a/sphinx/transforms/references.py +++ b/sphinx/transforms/references.py @@ -1,7 +1,4 @@ """ - sphinx.transforms.references - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 154bd60c1..554ade0cb 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.util - ~~~~~~~~~~~ - Utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py index b8221e5d5..68cdb6a31 100644 --- a/sphinx/util/build_phase.py +++ b/sphinx/util/build_phase.py @@ -1,7 +1,4 @@ """ - sphinx.util.build_phase - ~~~~~~~~~~~~~~~~~~~~~~~ - Build phase of Sphinx application. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py index a86cb6f4b..6b9b05966 100644 --- a/sphinx/util/cfamily.py +++ b/sphinx/util/cfamily.py @@ -1,7 +1,4 @@ """ - sphinx.util.cfamily - ~~~~~~~~~~~~~~~~~~~ - Utility functions common to the C and C++ domains. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index ae481de9b..0f644b838 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -1,7 +1,4 @@ """ - sphinx.util.compat - ~~~~~~~~~~~~~~~~~~ - modules for backward compatibility :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/console.py b/sphinx/util/console.py index 48b566283..62e4d297e 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -1,7 +1,4 @@ """ - sphinx.util.console - ~~~~~~~~~~~~~~~~~~~ - Format colored console output. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index a599c66a7..f81f80948 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -1,7 +1,4 @@ """ - sphinx.util.docfields - ~~~~~~~~~~~~~~~~~~~~~ - "Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index 620edf8c7..f634b438b 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,7 +1,4 @@ """ - sphinx.util.docstrings - ~~~~~~~~~~~~~~~~~~~~~~ - Utilities for docstring processing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index 5ab766649..90f00ddd5 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -1,7 +1,4 @@ """ - sphinx.util.docutils - ~~~~~~~~~~~~~~~~~~~~ - Utility functions for docutils. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py index c46a81cb6..7e412e2ec 100644 --- a/sphinx/util/fileutil.py +++ b/sphinx/util/fileutil.py @@ -1,7 +1,4 @@ """ - sphinx.util.fileutil - ~~~~~~~~~~~~~~~~~~~~ - File utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py index 511a9abee..0e0621fcd 100644 --- a/sphinx/util/i18n.py +++ b/sphinx/util/i18n.py @@ -1,7 +1,4 @@ """ - sphinx.util.i18n - ~~~~~~~~~~~~~~~~ - Builder superclass for all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/images.py b/sphinx/util/images.py index 12a253791..508617ca6 100644 --- a/sphinx/util/images.py +++ b/sphinx/util/images.py @@ -1,7 +1,4 @@ """ - sphinx.util.images - ~~~~~~~~~~~~~~~~~~ - Image utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 06920288f..9a66c0ec6 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -1,7 +1,4 @@ """ - sphinx.util.inspect - ~~~~~~~~~~~~~~~~~~~ - Helpers for inspecting Python modules. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py index a208affec..dfc3cd7ba 100644 --- a/sphinx/util/inventory.py +++ b/sphinx/util/inventory.py @@ -1,7 +1,4 @@ """ - sphinx.util.inventory - ~~~~~~~~~~~~~~~~~~~~~ - Inventory utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index 7db70dd5c..935a26119 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -1,7 +1,4 @@ """ - sphinx.util.jsdump - ~~~~~~~~~~~~~~~~~~ - This module implements a simple JavaScript serializer. Uses the basestring encode function from simplejson by Bob Ippolito. diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py index 7294885b5..b78707afe 100644 --- a/sphinx/util/logging.py +++ b/sphinx/util/logging.py @@ -1,7 +1,4 @@ """ - sphinx.util.logging - ~~~~~~~~~~~~~~~~~~~ - Logging utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index a89acf9a8..e8c000ee1 100644 --- a/sphinx/util/matching.py +++ b/sphinx/util/matching.py @@ -1,7 +1,4 @@ """ - sphinx.util.matching - ~~~~~~~~~~~~~~~~~~~~ - Pattern-matching utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/math.py b/sphinx/util/math.py index 664859624..0fa945890 100644 --- a/sphinx/util/math.py +++ b/sphinx/util/math.py @@ -1,7 +1,4 @@ """ - sphinx.util.math - ~~~~~~~~~~~~~~~~ - Utility functions for math. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index c16142a2c..3af9f4dd7 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -1,7 +1,4 @@ """ - sphinx.util.nodes - ~~~~~~~~~~~~~~~~~ - Docutils node-related utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index 4f69b4f38..e346170f0 100644 --- a/sphinx/util/osutil.py +++ b/sphinx/util/osutil.py @@ -1,7 +1,4 @@ """ - sphinx.util.osutil - ~~~~~~~~~~~~~~~~~~ - Operating system-related utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index 3f348a8b5..3783db7fc 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -1,7 +1,4 @@ """ - sphinx.util.parallel - ~~~~~~~~~~~~~~~~~~~~ - Parallel building utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/png.py b/sphinx/util/png.py index c40f653e6..ba9794f62 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -1,7 +1,4 @@ """ - sphinx.util.png - ~~~~~~~~~~~~~~~ - PNG image manipulation helpers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index 2b9b67be9..639ccb5ab 100644 --- a/sphinx/util/pycompat.py +++ b/sphinx/util/pycompat.py @@ -1,7 +1,4 @@ """ - sphinx.util.pycompat - ~~~~~~~~~~~~~~~~~~~~ - Stuff for Python version compatibility. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py index 581efbfd5..78b947ce8 100644 --- a/sphinx/util/requests.py +++ b/sphinx/util/requests.py @@ -1,7 +1,4 @@ """ - sphinx.util.requests - ~~~~~~~~~~~~~~~~~~~~ - Simple requests package loader :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index 320efa618..3cb9d64ba 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -1,7 +1,4 @@ """ - sphinx.util.rst - ~~~~~~~~~~~~~~~ - reST helper functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/smartypants.py b/sphinx/util/smartypants.py index 05d3b03bf..512ab839a 100644 --- a/sphinx/util/smartypants.py +++ b/sphinx/util/smartypants.py @@ -1,7 +1,4 @@ """ - sphinx.util.smartypants - ~~~~~~~~~~~~~~~~~~~~~~~ - This is extracted (with minor adaptations for flake8 compliance) from docutils’ docutils/utils/smartquotes.py as of revision 8097 (30 May 2017), in order to backport for Sphinx usage with Docutils < 0.14 extra language diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py index 65ef04350..0332e3f3b 100644 --- a/sphinx/util/stemmer/__init__.py +++ b/sphinx/util/stemmer/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.util.stemmer - ~~~~~~~~~~~~~~~~~~~ - Word stemming utilities for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/stemmer/porter.py b/sphinx/util/stemmer/porter.py index 52ca31e0c..e26431646 100644 --- a/sphinx/util/stemmer/porter.py +++ b/sphinx/util/stemmer/porter.py @@ -1,7 +1,4 @@ """ - sphinx.util.stemmer.porter - ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Porter Stemming Algorithm This is the Porter stemming algorithm, ported to Python from the diff --git a/sphinx/util/tags.py b/sphinx/util/tags.py index 67c023643..f5cd52f4d 100644 --- a/sphinx/util/tags.py +++ b/sphinx/util/tags.py @@ -1,7 +1,4 @@ """ - sphinx.util.tags - ~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/template.py b/sphinx/util/template.py index 5d5de52be..c684b8589 100644 --- a/sphinx/util/template.py +++ b/sphinx/util/template.py @@ -1,7 +1,4 @@ """ - sphinx.util.template - ~~~~~~~~~~~~~~~~~~~~ - Templates utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index 7efbb29ae..92b07521f 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -1,7 +1,4 @@ """ - sphinx.util.texescape - ~~~~~~~~~~~~~~~~~~~~~ - TeX escaping helper. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py index f47788005..df5c9f6e8 100644 --- a/sphinx/util/typing.py +++ b/sphinx/util/typing.py @@ -1,7 +1,4 @@ """ - sphinx.util.typing - ~~~~~~~~~~~~~~~~~~ - The composite types for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/versioning.py b/sphinx/versioning.py index 1a615101d..09be9aef7 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -1,7 +1,4 @@ """ - sphinx.versioning - ~~~~~~~~~~~~~~~~~ - Implements the low-level algorithms Sphinx uses for the versioning of doctrees. diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py index 0f8451bc9..668ecc0f5 100644 --- a/sphinx/writers/__init__.py +++ b/sphinx/writers/__init__.py @@ -1,7 +1,4 @@ """ - sphinx.writers - ~~~~~~~~~~~~~~ - Custom docutils writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index 34b73a0a5..e7efff848 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -1,7 +1,4 @@ """ - sphinx.writers.html - ~~~~~~~~~~~~~~~~~~~ - docutils writers handling Sphinx' custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index b9d0f648c..5324741cd 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -1,7 +1,4 @@ """ - sphinx.writers.html5 - ~~~~~~~~~~~~~~~~~~~~ - Experimental docutils writers for HTML5 handling Sphinx's custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 5afc5fca7..7956a854d 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -1,7 +1,4 @@ """ - sphinx.writers.latex - ~~~~~~~~~~~~~~~~~~~~ - Custom docutils writer for LaTeX. Much of this code is adapted from Dave Kuhlman's "docpy" writer from his diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index 0344d82e9..be7a405b7 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -1,7 +1,4 @@ """ - sphinx.writers.manpage - ~~~~~~~~~~~~~~~~~~~~~~ - Manual page writer, extended for Sphinx custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index 7913972a9..7b7af182d 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -1,7 +1,4 @@ """ - sphinx.writers.texinfo - ~~~~~~~~~~~~~~~~~~~~~~ - Custom docutils writer for Texinfo. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 9fef050c1..255beb848 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -1,7 +1,4 @@ """ - sphinx.writers.text - ~~~~~~~~~~~~~~~~~~~ - Custom docutils writer for plain text. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py index f9fb22784..733b6b3a2 100644 --- a/sphinx/writers/xml.py +++ b/sphinx/writers/xml.py @@ -1,7 +1,4 @@ """ - sphinx.writers.xml - ~~~~~~~~~~~~~~~~~~ - Docutils-native XML and pseudo-XML writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/conftest.py b/tests/conftest.py index dd1a04513..d04956fe1 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,7 +1,4 @@ """ - pytest config for sphinx/tests - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py index dd721355b..303387156 100644 --- a/tests/test_api_translator.py +++ b/tests/test_api_translator.py @@ -1,7 +1,4 @@ """ - test_api_translator - ~~~~~~~~~~~~~~~~~~~ - Test the Sphinx API for translator. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_application.py b/tests/test_application.py index fc85f193d..5eac1f7d0 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -1,7 +1,4 @@ """ - test_application - ~~~~~~~~~~~~~~~~ - Test the Sphinx class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build.py b/tests/test_build.py index 76de332ee..c5a34280d 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -1,7 +1,4 @@ """ - test_build - ~~~~~~~~~~ - Test all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_changes.py b/tests/test_build_changes.py index 65307ba92..67fe3701d 100644 --- a/tests/test_build_changes.py +++ b/tests/test_build_changes.py @@ -1,7 +1,4 @@ """ - test_build_changes - ~~~~~~~~~~~~~~~~~~ - Test the ChangesBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_dirhtml.py b/tests/test_build_dirhtml.py index a7a90623c..cb3958b7d 100644 --- a/tests/test_build_dirhtml.py +++ b/tests/test_build_dirhtml.py @@ -1,7 +1,4 @@ """ - test_build_dirhtml - ~~~~~~~~~~~~~~~~~~ - Test dirhtml builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_epub.py b/tests/test_build_epub.py index 851e8ac9d..ce2610b7b 100644 --- a/tests/test_build_epub.py +++ b/tests/test_build_epub.py @@ -1,7 +1,4 @@ """ - test_build_html - ~~~~~~~~~~~~~~~ - Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index 9398dfe5f..fd227a6a6 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -1,7 +1,4 @@ """ - test_build_gettext - ~~~~~~~~~~~~~~~~~~ - Test the build process with gettext builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 7688f76b3..795e93fac 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -1,7 +1,4 @@ """ - test_build_html - ~~~~~~~~~~~~~~~ - Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index b0ae85423..5a3dc1811 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -1,7 +1,4 @@ """ - test_build_latex - ~~~~~~~~~~~~~~~~ - Test the build process with LaTeX builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py index 358db6a4e..f5338020b 100644 --- a/tests/test_build_linkcheck.py +++ b/tests/test_build_linkcheck.py @@ -1,7 +1,4 @@ """ - test_build_linkcheck - ~~~~~~~~~~~~~~~~~~~~ - Test the build process with manpage builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_manpage.py b/tests/test_build_manpage.py index 1a14c9bf7..99b61bb0e 100644 --- a/tests/test_build_manpage.py +++ b/tests/test_build_manpage.py @@ -1,7 +1,4 @@ """ - test_build_manpage - ~~~~~~~~~~~~~~~~~~ - Test the build process with manpage builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py index 601de1587..3de24cfe4 100644 --- a/tests/test_build_texinfo.py +++ b/tests/test_build_texinfo.py @@ -1,7 +1,4 @@ """ - test_build_texinfo - ~~~~~~~~~~~~~~~~~~ - Test the build process with Texinfo builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_build_text.py b/tests/test_build_text.py index c080d2ad2..1b1b507a4 100644 --- a/tests/test_build_text.py +++ b/tests/test_build_text.py @@ -1,7 +1,4 @@ """ - test_build_text - ~~~~~~~~~~~~~~~ - Test the build process with Text builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_builder.py b/tests/test_builder.py index 4927e5d1d..cacea6e22 100644 --- a/tests/test_builder.py +++ b/tests/test_builder.py @@ -1,7 +1,4 @@ """ - test_builder - ~~~~~~~~ - Test the Builder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_catalogs.py b/tests/test_catalogs.py index 319e6a07d..e2c6b9b21 100644 --- a/tests/test_catalogs.py +++ b/tests/test_catalogs.py @@ -1,7 +1,4 @@ """ - test_build_base - ~~~~~~~~~~~~~~~ - Test the base build process. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_config.py b/tests/test_config.py index 97e911eb5..f64b912c4 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -1,7 +1,4 @@ """ - test_config - ~~~~~~~~~~~ - Test the sphinx.config.Config class and its handling in the Application class. diff --git a/tests/test_correct_year.py b/tests/test_correct_year.py index bcb217036..5c219df1d 100644 --- a/tests/test_correct_year.py +++ b/tests/test_correct_year.py @@ -1,7 +1,4 @@ """ - test_correct_year - ~~~~~~~~~~~~~~~~~ - Test copyright year adjustment :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_directive_code.py b/tests/test_directive_code.py index 5f519d3b9..e7a9d4505 100644 --- a/tests/test_directive_code.py +++ b/tests/test_directive_code.py @@ -1,7 +1,4 @@ """ - test_directive_code - ~~~~~~~~~~~~~~~~~~~ - Test the code-block directive. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_directive_only.py b/tests/test_directive_only.py index 164220e33..29ea531b8 100644 --- a/tests/test_directive_only.py +++ b/tests/test_directive_only.py @@ -1,7 +1,4 @@ """ - test_only_directive - ~~~~~~~~~~~~~~~~~~~ - Test the only directive with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_directive_other.py b/tests/test_directive_other.py index e1858f4e0..78118c10a 100644 --- a/tests/test_directive_other.py +++ b/tests/test_directive_other.py @@ -1,7 +1,4 @@ """ - test_directive_other - ~~~~~~~~~~~~~~~~~~~~ - Test the other directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_directive_patch.py b/tests/test_directive_patch.py index a199a89db..03f86f61b 100644 --- a/tests/test_directive_patch.py +++ b/tests/test_directive_patch.py @@ -1,7 +1,4 @@ """ - test_directive_patch - ~~~~~~~~~~~~~~~~~~~ - Test the patched directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py index 7e47c9ab3..342b3180b 100644 --- a/tests/test_docutilsconf.py +++ b/tests/test_docutilsconf.py @@ -1,7 +1,4 @@ """ - test_docutilsconf - ~~~~~~~~~~~~~~~~~ - Test docutils.conf support for several writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_domain_c.py b/tests/test_domain_c.py index f69008b8f..d386eb81b 100644 --- a/tests/test_domain_c.py +++ b/tests/test_domain_c.py @@ -1,7 +1,4 @@ """ - test_domain_c - ~~~~~~~~~~~~~ - Tests the C Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 8fc974f49..6239228e1 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -1,7 +1,4 @@ """ - test_domain_cpp - ~~~~~~~~~~~~~~~ - Tests the C++ Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_domain_js.py b/tests/test_domain_js.py index b109fe4d8..592360781 100644 --- a/tests/test_domain_js.py +++ b/tests/test_domain_js.py @@ -1,7 +1,4 @@ """ - test_domain_js - ~~~~~~~~~~~~~~ - Tests the JavaScript Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py index de544d25d..3ffc3f372 100644 --- a/tests/test_domain_py.py +++ b/tests/test_domain_py.py @@ -1,7 +1,4 @@ """ - test_domain_py - ~~~~~~~~~~~~~~ - Tests the Python Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_domain_rst.py b/tests/test_domain_rst.py index b79431d49..231aa6317 100644 --- a/tests/test_domain_rst.py +++ b/tests/test_domain_rst.py @@ -1,7 +1,4 @@ """ - test_rst_domain - ~~~~~~~~~~~~~~~ - Tests the reStructuredText domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py index 00e7361a3..5b5f87ff5 100644 --- a/tests/test_domain_std.py +++ b/tests/test_domain_std.py @@ -1,7 +1,4 @@ """ - test_domain_std - ~~~~~~~~~~~~~~~ - Tests the std domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_environment.py b/tests/test_environment.py index d8eec2c05..73ea690fa 100644 --- a/tests/test_environment.py +++ b/tests/test_environment.py @@ -1,7 +1,4 @@ """ - test_env - ~~~~~~~~ - Test the BuildEnvironment class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_environment_indexentries.py b/tests/test_environment_indexentries.py index f32592f9f..505b45e8f 100644 --- a/tests/test_environment_indexentries.py +++ b/tests/test_environment_indexentries.py @@ -1,7 +1,4 @@ """ - test_environment_indexentries - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the sphinx.environment.managers.indexentries. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py index dc5a184a4..a2a6a3ed9 100644 --- a/tests/test_environment_toctree.py +++ b/tests/test_environment_toctree.py @@ -1,7 +1,4 @@ """ - test_environment_toctree - ~~~~~~~~~~~~~~~~~~~~~~~~ - Test the sphinx.environment.managers.toctree. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_events.py b/tests/test_events.py index 44b0526d1..74649a869 100644 --- a/tests/test_events.py +++ b/tests/test_events.py @@ -1,7 +1,4 @@ """ - test_events - ~~~~~~~~~~~ - Test the EventManager class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py index 44c3308fe..4e4f8d89e 100644 --- a/tests/test_ext_apidoc.py +++ b/tests/test_ext_apidoc.py @@ -1,7 +1,4 @@ """ - test_apidoc - ~~~~~~~~~~~ - Test the sphinx.apidoc module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py index 62bbf83d0..3f48beb7a 100644 --- a/tests/test_ext_autodoc.py +++ b/tests/test_ext_autodoc.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc - ~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. diff --git a/tests/test_ext_autodoc_autoattribute.py b/tests/test_ext_autodoc_autoattribute.py index fec4da463..1907389d3 100644 --- a/tests/test_ext_autodoc_autoattribute.py +++ b/tests/test_ext_autodoc_autoattribute.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_autoattribute - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. diff --git a/tests/test_ext_autodoc_autoclass.py b/tests/test_ext_autodoc_autoclass.py index e68c72a58..fd90a7cab 100644 --- a/tests/test_ext_autodoc_autoclass.py +++ b/tests/test_ext_autodoc_autoclass.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_autoclass - ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. diff --git a/tests/test_ext_autodoc_autodata.py b/tests/test_ext_autodoc_autodata.py index 7d6d9eb30..7462e6182 100644 --- a/tests/test_ext_autodoc_autodata.py +++ b/tests/test_ext_autodoc_autodata.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_autodata - ~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. diff --git a/tests/test_ext_autodoc_autofunction.py b/tests/test_ext_autodoc_autofunction.py index 6489626d2..30586e08c 100644 --- a/tests/test_ext_autodoc_autofunction.py +++ b/tests/test_ext_autodoc_autofunction.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_autofunction - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. diff --git a/tests/test_ext_autodoc_automodule.py b/tests/test_ext_autodoc_automodule.py index 05a73ac81..8aec1fb48 100644 --- a/tests/test_ext_autodoc_automodule.py +++ b/tests/test_ext_autodoc_automodule.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_autocmodule - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. diff --git a/tests/test_ext_autodoc_autoproperty.py b/tests/test_ext_autodoc_autoproperty.py index 4b62165e3..b967d65b8 100644 --- a/tests/test_ext_autodoc_autoproperty.py +++ b/tests/test_ext_autodoc_autoproperty.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_autoproperty - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. diff --git a/tests/test_ext_autodoc_configs.py b/tests/test_ext_autodoc_configs.py index e84e360e8..ce4f0e064 100644 --- a/tests/test_ext_autodoc_configs.py +++ b/tests/test_ext_autodoc_configs.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_configs - ~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly for config variables :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_events.py b/tests/test_ext_autodoc_events.py index 6a71054c2..0adb0d6a1 100644 --- a/tests/test_ext_autodoc_events.py +++ b/tests/test_ext_autodoc_events.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_events - ~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly for autodoc events :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_mock.py b/tests/test_ext_autodoc_mock.py index c207c82fc..1a7a39aa0 100644 --- a/tests/test_ext_autodoc_mock.py +++ b/tests/test_ext_autodoc_mock.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_mock - ~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_preserve_defaults.py b/tests/test_ext_autodoc_preserve_defaults.py index a7a24e026..54c26e226 100644 --- a/tests/test_ext_autodoc_preserve_defaults.py +++ b/tests/test_ext_autodoc_preserve_defaults.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_preserve_defaults - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_private_members.py b/tests/test_ext_autodoc_private_members.py index f685f774c..dbb8f759b 100644 --- a/tests/test_ext_autodoc_private_members.py +++ b/tests/test_ext_autodoc_private_members.py @@ -1,7 +1,4 @@ """ - test_ext_autodoc_private_members - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test the autodoc extension. This tests mainly for private-members option. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autosectionlabel.py b/tests/test_ext_autosectionlabel.py index ccbc9ed77..307439e99 100644 --- a/tests/test_ext_autosectionlabel.py +++ b/tests/test_ext_autosectionlabel.py @@ -1,7 +1,4 @@ """ - test_ext_autosectionlabel - ~~~~~~~~~~~~~~~~~~~~~~~~~ - Test sphinx.ext.autosectionlabel extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py index 13da15e50..3bc4d3bd9 100644 --- a/tests/test_ext_autosummary.py +++ b/tests/test_ext_autosummary.py @@ -1,7 +1,4 @@ """ - test_autosummary - ~~~~~~~~~~~~~~~~ - Test the autosummary extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_coverage.py b/tests/test_ext_coverage.py index 6d6fbcf1d..4c2e799bd 100644 --- a/tests/test_ext_coverage.py +++ b/tests/test_ext_coverage.py @@ -1,7 +1,4 @@ """ - test_coverage - ~~~~~~~~~~~~~ - Test the coverage builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index 3a527acb2..dbda96c15 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -1,7 +1,4 @@ """ - test_doctest - ~~~~~~~~~~~~ - Test the doctest extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_duration.py b/tests/test_ext_duration.py index b16cbc4f4..c1f2ca96e 100644 --- a/tests/test_ext_duration.py +++ b/tests/test_ext_duration.py @@ -1,7 +1,4 @@ """ - test_ext_duration - ~~~~~~~~~~~~~~~~~ - Test sphinx.ext.duration extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_githubpages.py b/tests/test_ext_githubpages.py index 9d87b0212..3b63a2c2e 100644 --- a/tests/test_ext_githubpages.py +++ b/tests/test_ext_githubpages.py @@ -1,7 +1,4 @@ """ - test_ext_githubpages - ~~~~~~~~~~~~~~~~~~~~ - Test sphinx.ext.githubpages extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py index 15eaf6050..f916fb1b9 100644 --- a/tests/test_ext_graphviz.py +++ b/tests/test_ext_graphviz.py @@ -1,7 +1,4 @@ """ - test_ext_graphviz - ~~~~~~~~~~~~~~~~~ - Test sphinx.ext.graphviz extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_ifconfig.py b/tests/test_ext_ifconfig.py index f8f897149..4bc7f519f 100644 --- a/tests/test_ext_ifconfig.py +++ b/tests/test_ext_ifconfig.py @@ -1,7 +1,4 @@ """ - test_ext_ifconfig - ~~~~~~~~~~~~~~~~~ - Test sphinx.ext.ifconfig extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_imgconverter.py b/tests/test_ext_imgconverter.py index b4dbf125b..478bf8df4 100644 --- a/tests/test_ext_imgconverter.py +++ b/tests/test_ext_imgconverter.py @@ -1,7 +1,4 @@ """ - test_ext_imgconverter - ~~~~~~~~~~~~~~~~~~~~~ - Test sphinx.ext.imgconverter extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py index bd563b4fc..ad594c2eb 100644 --- a/tests/test_ext_inheritance_diagram.py +++ b/tests/test_ext_inheritance_diagram.py @@ -1,7 +1,4 @@ """ - test_ext_inheritance_diagram - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Test sphinx.ext.inheritance_diagram extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py index b2ad8afe5..21ce6f952 100644 --- a/tests/test_ext_intersphinx.py +++ b/tests/test_ext_intersphinx.py @@ -1,7 +1,4 @@ """ - test_intersphinx - ~~~~~~~~~~~~~~~~ - Test the intersphinx extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index 5dd713961..20fc75279 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -1,7 +1,4 @@ """ - test_ext_math - ~~~~~~~~~~~~~ - Test math extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_napoleon.py b/tests/test_ext_napoleon.py index 250fdae26..75894f9c0 100644 --- a/tests/test_ext_napoleon.py +++ b/tests/test_ext_napoleon.py @@ -1,7 +1,4 @@ """ - test_napoleon - ~~~~~~~~~~~~~ - Tests for :mod:`sphinx.ext.napoleon.__init__` module. diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index 21278dbca..eb2252fb9 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -1,7 +1,4 @@ """ - test_napoleon_docstring - ~~~~~~~~~~~~~~~~~~~~~~~ - Tests for :mod:`sphinx.ext.napoleon.docstring` module. diff --git a/tests/test_ext_napoleon_iterators.py b/tests/test_ext_napoleon_iterators.py index 95c2778e8..0ccc94a06 100644 --- a/tests/test_ext_napoleon_iterators.py +++ b/tests/test_ext_napoleon_iterators.py @@ -1,7 +1,4 @@ """ - test_napoleon_iterators - ~~~~~~~~~~~~~~~~~~~~~~~ - Tests for :mod:`sphinx.ext.napoleon.iterators` module. diff --git a/tests/test_ext_todo.py b/tests/test_ext_todo.py index 3bc2abadf..010b66034 100644 --- a/tests/test_ext_todo.py +++ b/tests/test_ext_todo.py @@ -1,7 +1,4 @@ """ - test_ext_todo - ~~~~~~~~~~~~~ - Test sphinx.ext.todo extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py index 140b2a728..5b416d14d 100644 --- a/tests/test_ext_viewcode.py +++ b/tests/test_ext_viewcode.py @@ -1,7 +1,4 @@ """ - test_ext_viewcode - ~~~~~~~~~~~~~~~~~ - Test sphinx.ext.viewcode extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_extension.py b/tests/test_extension.py index 4e7fffffa..0955dc382 100644 --- a/tests/test_extension.py +++ b/tests/test_extension.py @@ -1,7 +1,4 @@ """ - test_extension - ~~~~~~~~~~~~~~ - Test sphinx.extension module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index d83f2f1cc..4238882df 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -1,7 +1,4 @@ """ - test_highlighting - ~~~~~~~~~~~~~~~~~ - Test the Pygments highlighting bridge. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_intl.py b/tests/test_intl.py index 62dbb1352..c89df5732 100644 --- a/tests/test_intl.py +++ b/tests/test_intl.py @@ -1,7 +1,4 @@ """ - test_intl - ~~~~~~~~~ - Test message patching for internationalization purposes. Runs the text builder in the test root. diff --git a/tests/test_locale.py b/tests/test_locale.py index c5765ccdf..aadac7b8f 100644 --- a/tests/test_locale.py +++ b/tests/test_locale.py @@ -1,7 +1,4 @@ """ - test_locale - ~~~~~~~~~~ - Test locale. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_markup.py b/tests/test_markup.py index dbd0f0272..a2ffbf17e 100644 --- a/tests/test_markup.py +++ b/tests/test_markup.py @@ -1,7 +1,4 @@ """ - test_markup - ~~~~~~~~~~~ - Test various Sphinx-specific markup extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_metadata.py b/tests/test_metadata.py index a2e26a42b..86a9896bf 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1,7 +1,4 @@ """ - test_metadata - ~~~~~~~~~~~~~ - Test our handling of metadata in files with bibliographic metadata. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_parser.py b/tests/test_parser.py index cbe9a61df..8098c74af 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -1,7 +1,4 @@ """ - test_sphinx_parsers - ~~~~~~~~~~~~~~~~~~~ - Tests parsers module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_project.py b/tests/test_project.py index dc7f1d35d..6996e8202 100644 --- a/tests/test_project.py +++ b/tests/test_project.py @@ -1,7 +1,4 @@ """ - test_project - ~~~~~~~~~~~~ - Tests project module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_pycode.py b/tests/test_pycode.py index 312c0245d..267395a21 100644 --- a/tests/test_pycode.py +++ b/tests/test_pycode.py @@ -1,7 +1,4 @@ """ - test_pycode - ~~~~~~~~~~~ - Test pycode. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_pycode_ast.py b/tests/test_pycode_ast.py index 0de03d5ea..d1150e3b0 100644 --- a/tests/test_pycode_ast.py +++ b/tests/test_pycode_ast.py @@ -1,7 +1,4 @@ """ - test_pycode_ast - ~~~~~~~~~~~~~~~ - Test pycode.ast :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_pycode_parser.py b/tests/test_pycode_parser.py index 11e47a86b..264636907 100644 --- a/tests/test_pycode_parser.py +++ b/tests/test_pycode_parser.py @@ -1,7 +1,4 @@ """ - test_pycode_parser - ~~~~~~~~~~~~~~~~~~ - Test pycode.parser. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py index 0f317c5a8..940897b5b 100644 --- a/tests/test_quickstart.py +++ b/tests/test_quickstart.py @@ -1,7 +1,4 @@ """ - test_quickstart - ~~~~~~~~~~~~~~~ - Test the sphinx.quickstart module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_roles.py b/tests/test_roles.py index a7e936376..b531c7d8b 100644 --- a/tests/test_roles.py +++ b/tests/test_roles.py @@ -1,7 +1,4 @@ """ - test_roles - ~~~~~~~~~~ - Test sphinx.roles :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_search.py b/tests/test_search.py index 4c74ac24a..e2cac35c1 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -1,7 +1,4 @@ """ - test_search - ~~~~~~~~~~~ - Test the search index builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py index 0a1176ae6..41571a2c1 100644 --- a/tests/test_setup_command.py +++ b/tests/test_setup_command.py @@ -1,7 +1,4 @@ """ - test_setup_command - ~~~~~~~~~~~~~~~~~~~ - Test setup_command for distutils. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_smartquotes.py b/tests/test_smartquotes.py index bd8216167..78f0faae8 100644 --- a/tests/test_smartquotes.py +++ b/tests/test_smartquotes.py @@ -1,7 +1,4 @@ """ - test_smartquotes - ~~~~~~~~~~~~~~~~ - Test smart quotes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_templating.py b/tests/test_templating.py index 37e280c3b..1def07050 100644 --- a/tests/test_templating.py +++ b/tests/test_templating.py @@ -1,7 +1,4 @@ """ - test_templating - ~~~~~~~~~~~~~~~~ - Test templating. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_theming.py b/tests/test_theming.py index 60dd72cdf..b760671bc 100644 --- a/tests/test_theming.py +++ b/tests/test_theming.py @@ -1,7 +1,4 @@ """ - test_theming - ~~~~~~~~~~~~ - Test the Theme class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_toctree.py b/tests/test_toctree.py index 33e73c98c..62f561d87 100644 --- a/tests/test_toctree.py +++ b/tests/test_toctree.py @@ -1,7 +1,4 @@ """ - test_toctree - ~~~~~~~~~~~~ - Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_transforms_post_transforms.py b/tests/test_transforms_post_transforms.py index fe0a7b06b..c3e7613fe 100644 --- a/tests/test_transforms_post_transforms.py +++ b/tests/test_transforms_post_transforms.py @@ -1,7 +1,4 @@ """ - test_transforms_post_transforms - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Tests the post_transforms :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_transforms_post_transforms_code.py b/tests/test_transforms_post_transforms_code.py index 11369d2ba..c890df294 100644 --- a/tests/test_transforms_post_transforms_code.py +++ b/tests/test_transforms_post_transforms_code.py @@ -1,7 +1,4 @@ """ - test_transforms_post_transforms_code - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_util.py b/tests/test_util.py index 0023bbcdb..ade5d36f9 100644 --- a/tests/test_util.py +++ b/tests/test_util.py @@ -1,7 +1,4 @@ """ - test_util - ~~~~~~~~~~~~~~~ - Tests util functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_docstrings.py b/tests/test_util_docstrings.py index 73f155cf3..fe8727e66 100644 --- a/tests/test_util_docstrings.py +++ b/tests/test_util_docstrings.py @@ -1,7 +1,4 @@ """ - test_util_docstrings - ~~~~~~~~~~~~~~~~~~~~ - Test sphinx.util.docstrings. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_docutils.py b/tests/test_util_docutils.py index 9a7a05e49..2ee8953a7 100644 --- a/tests/test_util_docutils.py +++ b/tests/test_util_docutils.py @@ -1,7 +1,4 @@ """ - test_util_docutils - ~~~~~~~~~~~~~~~~~~ - Tests util.utils functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_fileutil.py b/tests/test_util_fileutil.py index 4d6edd0ce..90264a945 100644 --- a/tests/test_util_fileutil.py +++ b/tests/test_util_fileutil.py @@ -1,7 +1,4 @@ """ - test_util_fileutil - ~~~~~~~~~~~~~~~~~~ - Tests sphinx.util.fileutil functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_i18n.py b/tests/test_util_i18n.py index 3f4e8d52a..fd67446ae 100644 --- a/tests/test_util_i18n.py +++ b/tests/test_util_i18n.py @@ -1,7 +1,4 @@ """ - test_util_i18n - ~~~~~~~~~~~~~~ - Test i18n util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_images.py b/tests/test_util_images.py index e2c0c61f0..5dbe2a8ed 100644 --- a/tests/test_util_images.py +++ b/tests/test_util_images.py @@ -1,7 +1,4 @@ """ - test_util_images - ~~~~~~~~~~~~~~~~ - Test images util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 9e570da76..18abbe86c 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -1,7 +1,4 @@ """ - test_util_inspect - ~~~~~~~~~~~~~~~ - Tests util.inspect functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_inventory.py b/tests/test_util_inventory.py index 305ef4353..d621fd17d 100644 --- a/tests/test_util_inventory.py +++ b/tests/test_util_inventory.py @@ -1,7 +1,4 @@ """ - test_util_inventory - ~~~~~~~~~~~~~~~~~~~ - Test inventory util functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py index 3c78368d1..bb3d3260a 100644 --- a/tests/test_util_logging.py +++ b/tests/test_util_logging.py @@ -1,7 +1,4 @@ """ - test_util_logging - ~~~~~~~~~~~~~~~~~ - Test logging util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_matching.py b/tests/test_util_matching.py index 651546c92..91d284b23 100644 --- a/tests/test_util_matching.py +++ b/tests/test_util_matching.py @@ -1,7 +1,4 @@ """ - test_util_matching - ~~~~~~~~~~~~~~~~~~ - Tests sphinx.util.matching functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_nodes.py b/tests/test_util_nodes.py index fe0a278e6..a682dc295 100644 --- a/tests/test_util_nodes.py +++ b/tests/test_util_nodes.py @@ -1,7 +1,4 @@ """ - test_util_nodes - ~~~~~~~~~~~~~~~ - Tests uti.nodes functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_rst.py b/tests/test_util_rst.py index da3dba707..4f76f584a 100644 --- a/tests/test_util_rst.py +++ b/tests/test_util_rst.py @@ -1,7 +1,4 @@ """ - test_util_rst - ~~~~~~~~~~~~~~~ - Tests sphinx.util.rst functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_template.py b/tests/test_util_template.py index 36f1dac35..b752a4c34 100644 --- a/tests/test_util_template.py +++ b/tests/test_util_template.py @@ -1,7 +1,4 @@ """ - test_util_template - ~~~~~~~~~~~~~~~~~~ - Tests sphinx.util.template functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_util_typing.py b/tests/test_util_typing.py index 7d81fee5d..ca3611a44 100644 --- a/tests/test_util_typing.py +++ b/tests/test_util_typing.py @@ -1,7 +1,4 @@ """ - test_util_typing - ~~~~~~~~~~~~~~~~ - Tests util.typing functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_versioning.py b/tests/test_versioning.py index 4de8331aa..f615eb2cc 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -1,7 +1,4 @@ """ - test_versioning - ~~~~~~~~~~~~~~~ - Test the versioning implementation. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_writer_latex.py b/tests/test_writer_latex.py index ccb578f3e..31d27d591 100644 --- a/tests/test_writer_latex.py +++ b/tests/test_writer_latex.py @@ -1,7 +1,4 @@ """ - test_writer_latex - ~~~~~~~~~~~~~~~~ - Test the LaTeX writer :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/utils/checks.py b/utils/checks.py index 093817409..6798fde01 100644 --- a/utils/checks.py +++ b/utils/checks.py @@ -1,7 +1,4 @@ """ - utils.checks - ~~~~~~~~~~~~ - Custom, Sphinx-only flake8 plugins. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. diff --git a/utils/doclinter.py b/utils/doclinter.py index b4b27748a..ed61b9c97 100644 --- a/utils/doclinter.py +++ b/utils/doclinter.py @@ -1,7 +1,4 @@ """ - utils.doclinter - ~~~~~~~~~~~~~~~ - A linter for Sphinx docs :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. diff --git a/utils/jssplitter_generator.py b/utils/jssplitter_generator.py index 7806d64d2..0e95cfe56 100644 --- a/utils/jssplitter_generator.py +++ b/utils/jssplitter_generator.py @@ -113,9 +113,6 @@ console.log(' ... ok\\n') python_src = '''\ """ - sphinx.search.jssplitter - ~~~~~~~~~~~~~~~~~~~~~~~~ - Provides Python compatible word splitter to JavaScript DO NOT EDIT. This is generated by utils/jssplitter_generator.py From 4f5a3269a6053fe659093096d9b635a2c8e7e55e Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 00:06:24 +0000 Subject: [PATCH 2/9] Fix module docstring first line --- sphinx/__init__.py | 3 +-- sphinx/__main__.py | 3 +-- sphinx/addnodes.py | 3 +-- sphinx/application.py | 3 +-- sphinx/builders/__init__.py | 3 +-- sphinx/builders/_epub_base.py | 3 +-- sphinx/builders/changes.py | 3 +-- sphinx/builders/dirhtml.py | 3 +-- sphinx/builders/dummy.py | 3 +-- sphinx/builders/epub3.py | 3 +-- sphinx/builders/gettext.py | 3 +-- sphinx/builders/html/__init__.py | 3 +-- sphinx/builders/html/transforms.py | 3 +-- sphinx/builders/latex/__init__.py | 3 +-- sphinx/builders/latex/constants.py | 3 +-- sphinx/builders/latex/nodes.py | 3 +-- sphinx/builders/latex/theming.py | 3 +-- sphinx/builders/latex/transforms.py | 3 +-- sphinx/builders/latex/util.py | 3 +-- sphinx/builders/linkcheck.py | 3 +-- sphinx/builders/manpage.py | 3 +-- sphinx/builders/singlehtml.py | 3 +-- sphinx/builders/texinfo.py | 3 +-- sphinx/builders/text.py | 3 +-- sphinx/builders/xml.py | 3 +-- sphinx/cmd/__init__.py | 3 +-- sphinx/cmd/build.py | 3 +-- sphinx/cmd/make_mode.py | 3 +-- sphinx/cmd/quickstart.py | 3 +-- sphinx/config.py | 3 +-- sphinx/deprecation.py | 3 +-- sphinx/directives/__init__.py | 3 +-- sphinx/domains/__init__.py | 3 +-- sphinx/domains/c.py | 3 +-- sphinx/domains/changeset.py | 3 +-- sphinx/domains/citation.py | 3 +-- sphinx/domains/cpp.py | 3 +-- sphinx/domains/index.py | 3 +-- sphinx/domains/javascript.py | 3 +-- sphinx/domains/math.py | 3 +-- sphinx/domains/python.py | 3 +-- sphinx/domains/rst.py | 3 +-- sphinx/domains/std.py | 3 +-- sphinx/environment/__init__.py | 3 +-- sphinx/environment/adapters/__init__.py | 3 +-- sphinx/environment/adapters/asset.py | 3 +-- sphinx/environment/adapters/indexentries.py | 3 +-- sphinx/environment/adapters/toctree.py | 3 +-- sphinx/environment/collectors/__init__.py | 3 +-- sphinx/environment/collectors/asset.py | 3 +-- sphinx/environment/collectors/dependencies.py | 3 +-- sphinx/environment/collectors/metadata.py | 3 +-- sphinx/environment/collectors/title.py | 3 +-- sphinx/environment/collectors/toctree.py | 3 +-- sphinx/errors.py | 3 +-- sphinx/events.py | 3 +-- sphinx/ext/__init__.py | 3 +-- sphinx/ext/apidoc.py | 3 +-- sphinx/ext/autodoc/__init__.py | 3 +-- sphinx/ext/autodoc/deprecated.py | 3 +-- sphinx/ext/autodoc/importer.py | 3 +-- sphinx/ext/autodoc/mock.py | 3 +-- sphinx/ext/autodoc/preserve_defaults.py | 3 +-- sphinx/ext/autodoc/type_comment.py | 3 +-- sphinx/ext/autodoc/typehints.py | 3 +-- sphinx/ext/autosectionlabel.py | 3 +-- sphinx/ext/autosummary/__init__.py | 3 +-- sphinx/ext/autosummary/generate.py | 3 +-- sphinx/ext/coverage.py | 3 +-- sphinx/ext/doctest.py | 3 +-- sphinx/ext/duration.py | 3 +-- sphinx/ext/extlinks.py | 3 +-- sphinx/ext/githubpages.py | 3 +-- sphinx/ext/graphviz.py | 3 +-- sphinx/ext/ifconfig.py | 3 +-- sphinx/ext/imgconverter.py | 3 +-- sphinx/ext/imgmath.py | 3 +-- sphinx/ext/inheritance_diagram.py | 3 +-- sphinx/ext/intersphinx.py | 3 +-- sphinx/ext/linkcode.py | 3 +-- sphinx/ext/mathjax.py | 3 +-- sphinx/ext/napoleon/__init__.py | 3 +-- sphinx/ext/todo.py | 3 +-- sphinx/ext/viewcode.py | 3 +-- sphinx/extension.py | 3 +-- sphinx/highlighting.py | 3 +-- sphinx/io.py | 3 +-- sphinx/jinja2glue.py | 3 +-- sphinx/locale/__init__.py | 3 +-- sphinx/parsers.py | 3 +-- sphinx/project.py | 3 +-- sphinx/pycode/__init__.py | 3 +-- sphinx/pycode/ast.py | 3 +-- sphinx/pycode/parser.py | 3 +-- sphinx/pygments_styles.py | 3 +-- sphinx/registry.py | 3 +-- sphinx/roles.py | 3 +-- sphinx/search/__init__.py | 3 +-- sphinx/search/da.py | 3 +-- sphinx/search/de.py | 3 +-- sphinx/search/en.py | 3 +-- sphinx/search/es.py | 3 +-- sphinx/search/fi.py | 3 +-- sphinx/search/fr.py | 3 +-- sphinx/search/hu.py | 3 +-- sphinx/search/it.py | 3 +-- sphinx/search/ja.py | 3 +-- sphinx/search/jssplitter.py | 3 +-- sphinx/search/nl.py | 3 +-- sphinx/search/no.py | 3 +-- sphinx/search/pt.py | 3 +-- sphinx/search/ro.py | 3 +-- sphinx/search/ru.py | 3 +-- sphinx/search/sv.py | 3 +-- sphinx/search/tr.py | 3 +-- sphinx/search/zh.py | 3 +-- sphinx/setup_command.py | 3 +-- sphinx/testing/__init__.py | 3 +-- sphinx/testing/comparer.py | 3 +-- sphinx/testing/fixtures.py | 3 +-- sphinx/testing/util.py | 3 +-- sphinx/theming.py | 3 +-- sphinx/transforms/__init__.py | 3 +-- sphinx/transforms/compact_bullet_list.py | 3 +-- sphinx/transforms/i18n.py | 3 +-- sphinx/transforms/post_transforms/__init__.py | 3 +-- sphinx/transforms/post_transforms/code.py | 3 +-- sphinx/transforms/post_transforms/images.py | 3 +-- sphinx/transforms/references.py | 3 +-- sphinx/util/__init__.py | 3 +-- sphinx/util/build_phase.py | 3 +-- sphinx/util/cfamily.py | 3 +-- sphinx/util/compat.py | 3 +-- sphinx/util/console.py | 3 +-- sphinx/util/docfields.py | 3 +-- sphinx/util/docstrings.py | 3 +-- sphinx/util/docutils.py | 3 +-- sphinx/util/fileutil.py | 3 +-- sphinx/util/i18n.py | 3 +-- sphinx/util/images.py | 3 +-- sphinx/util/inspect.py | 3 +-- sphinx/util/inventory.py | 3 +-- sphinx/util/jsdump.py | 3 +-- sphinx/util/logging.py | 3 +-- sphinx/util/matching.py | 3 +-- sphinx/util/math.py | 3 +-- sphinx/util/nodes.py | 3 +-- sphinx/util/osutil.py | 3 +-- sphinx/util/parallel.py | 3 +-- sphinx/util/png.py | 3 +-- sphinx/util/pycompat.py | 3 +-- sphinx/util/requests.py | 3 +-- sphinx/util/rst.py | 3 +-- sphinx/util/smartypants.py | 3 +-- sphinx/util/stemmer/__init__.py | 3 +-- sphinx/util/stemmer/porter.py | 3 +-- sphinx/util/template.py | 3 +-- sphinx/util/texescape.py | 3 +-- sphinx/util/typing.py | 3 +-- sphinx/versioning.py | 3 +-- sphinx/writers/__init__.py | 3 +-- sphinx/writers/html.py | 3 +-- sphinx/writers/html5.py | 3 +-- sphinx/writers/latex.py | 3 +-- sphinx/writers/manpage.py | 3 +-- sphinx/writers/texinfo.py | 3 +-- sphinx/writers/text.py | 3 +-- sphinx/writers/xml.py | 3 +-- tests/roots/test-inheritance/dummy/test_nested.py | 3 +-- tests/test_api_translator.py | 3 +-- tests/test_application.py | 3 +-- tests/test_build.py | 3 +-- tests/test_build_changes.py | 3 +-- tests/test_build_dirhtml.py | 3 +-- tests/test_build_epub.py | 3 +-- tests/test_build_gettext.py | 3 +-- tests/test_build_html.py | 3 +-- tests/test_build_latex.py | 3 +-- tests/test_build_linkcheck.py | 3 +-- tests/test_build_manpage.py | 3 +-- tests/test_build_texinfo.py | 3 +-- tests/test_build_text.py | 3 +-- tests/test_builder.py | 3 +-- tests/test_catalogs.py | 3 +-- tests/test_config.py | 3 +-- tests/test_correct_year.py | 3 +-- tests/test_directive_code.py | 3 +-- tests/test_directive_only.py | 3 +-- tests/test_directive_other.py | 3 +-- tests/test_directive_patch.py | 3 +-- tests/test_docutilsconf.py | 3 +-- tests/test_domain_c.py | 3 +-- tests/test_domain_cpp.py | 3 +-- tests/test_domain_js.py | 3 +-- tests/test_domain_py.py | 3 +-- tests/test_domain_rst.py | 3 +-- tests/test_domain_std.py | 3 +-- tests/test_environment.py | 3 +-- tests/test_environment_indexentries.py | 3 +-- tests/test_environment_toctree.py | 3 +-- tests/test_events.py | 3 +-- tests/test_ext_apidoc.py | 3 +-- tests/test_ext_autodoc.py | 3 +-- tests/test_ext_autodoc_autoattribute.py | 3 +-- tests/test_ext_autodoc_autoclass.py | 3 +-- tests/test_ext_autodoc_autodata.py | 3 +-- tests/test_ext_autodoc_autofunction.py | 3 +-- tests/test_ext_autodoc_automodule.py | 3 +-- tests/test_ext_autodoc_autoproperty.py | 3 +-- tests/test_ext_autodoc_configs.py | 3 +-- tests/test_ext_autodoc_events.py | 3 +-- tests/test_ext_autodoc_mock.py | 3 +-- tests/test_ext_autodoc_preserve_defaults.py | 3 +-- tests/test_ext_autodoc_private_members.py | 3 +-- tests/test_ext_autosectionlabel.py | 3 +-- tests/test_ext_autosummary.py | 3 +-- tests/test_ext_coverage.py | 3 +-- tests/test_ext_doctest.py | 3 +-- tests/test_ext_duration.py | 3 +-- tests/test_ext_githubpages.py | 3 +-- tests/test_ext_graphviz.py | 3 +-- tests/test_ext_ifconfig.py | 3 +-- tests/test_ext_imgconverter.py | 3 +-- tests/test_ext_inheritance_diagram.py | 3 +-- tests/test_ext_intersphinx.py | 3 +-- tests/test_ext_math.py | 3 +-- tests/test_ext_napoleon.py | 3 +-- tests/test_ext_napoleon_docstring.py | 3 +-- tests/test_ext_napoleon_iterators.py | 3 +-- tests/test_ext_todo.py | 3 +-- tests/test_ext_viewcode.py | 3 +-- tests/test_extension.py | 3 +-- tests/test_highlighting.py | 3 +-- tests/test_intl.py | 3 +-- tests/test_locale.py | 3 +-- tests/test_markup.py | 3 +-- tests/test_metadata.py | 3 +-- tests/test_parser.py | 3 +-- tests/test_project.py | 3 +-- tests/test_pycode.py | 3 +-- tests/test_pycode_ast.py | 3 +-- tests/test_pycode_parser.py | 3 +-- tests/test_quickstart.py | 3 +-- tests/test_roles.py | 3 +-- tests/test_search.py | 3 +-- tests/test_setup_command.py | 3 +-- tests/test_smartquotes.py | 3 +-- tests/test_templating.py | 3 +-- tests/test_theming.py | 3 +-- tests/test_toctree.py | 3 +-- tests/test_transforms_post_transforms.py | 3 +-- tests/test_util.py | 3 +-- tests/test_util_docstrings.py | 3 +-- tests/test_util_docutils.py | 3 +-- tests/test_util_fileutil.py | 3 +-- tests/test_util_i18n.py | 3 +-- tests/test_util_images.py | 3 +-- tests/test_util_inspect.py | 3 +-- tests/test_util_inventory.py | 3 +-- tests/test_util_logging.py | 3 +-- tests/test_util_matching.py | 3 +-- tests/test_util_nodes.py | 3 +-- tests/test_util_rst.py | 3 +-- tests/test_util_template.py | 3 +-- tests/test_util_typing.py | 3 +-- tests/test_versioning.py | 3 +-- tests/test_writer_latex.py | 3 +-- utils/checks.py | 3 +-- utils/doclinter.py | 3 +-- utils/jssplitter_generator.py | 3 +-- 270 files changed, 270 insertions(+), 540 deletions(-) diff --git a/sphinx/__init__.py b/sphinx/__init__.py index 197d678c9..656f0bf39 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -1,5 +1,4 @@ -""" - The Sphinx documentation toolchain. +"""The Sphinx documentation toolchain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/__main__.py b/sphinx/__main__.py index 2d750a0c2..8897f3231 100644 --- a/sphinx/__main__.py +++ b/sphinx/__main__.py @@ -1,5 +1,4 @@ -""" - The Sphinx documentation toolchain. +"""The Sphinx documentation toolchain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index 5f0ea74ee..d2af6aa32 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -1,5 +1,4 @@ -""" - Additional docutils nodes. +"""Additional docutils nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/application.py b/sphinx/application.py index 640c14e4e..d060d3e35 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -1,5 +1,4 @@ -""" - Sphinx application class and extensibility interface. +"""Sphinx application class and extensibility interface. Gracefully adapted from the TextPress system by Armin. diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index 0fd3649a2..e1f0ad4ec 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -1,5 +1,4 @@ -""" - Builder superclass for all builders. +"""Builder superclass for all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index 1bdaf39ea..099be31b4 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -1,5 +1,4 @@ -""" - Base class of epub2/epub3 builders. +"""Base class of epub2/epub3 builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index 84ea55f0d..37b1afb1a 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -1,5 +1,4 @@ -""" - Changelog builder. +"""Changelog builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/dirhtml.py b/sphinx/builders/dirhtml.py index 5e9218d3f..9ffe634fe 100644 --- a/sphinx/builders/dirhtml.py +++ b/sphinx/builders/dirhtml.py @@ -1,5 +1,4 @@ -""" - Directory HTML builders. +"""Directory HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/dummy.py b/sphinx/builders/dummy.py index 083bde2f9..b1d5414df 100644 --- a/sphinx/builders/dummy.py +++ b/sphinx/builders/dummy.py @@ -1,5 +1,4 @@ -""" - Do syntax checks, but no writing. +"""Do syntax checks, but no writing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/epub3.py b/sphinx/builders/epub3.py index 9f204db2c..c7a9cb164 100644 --- a/sphinx/builders/epub3.py +++ b/sphinx/builders/epub3.py @@ -1,5 +1,4 @@ -""" - Build epub3 files. +"""Build epub3 files. Originally derived from epub.py. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index d07a89575..16d49f25d 100644 --- a/sphinx/builders/gettext.py +++ b/sphinx/builders/gettext.py @@ -1,5 +1,4 @@ -""" - The MessageCatalogBuilder class. +"""The MessageCatalogBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py index e6c5ea5ae..56008e474 100644 --- a/sphinx/builders/html/__init__.py +++ b/sphinx/builders/html/__init__.py @@ -1,5 +1,4 @@ -""" - Several HTML builders. +"""Several HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/html/transforms.py b/sphinx/builders/html/transforms.py index 3f36c195d..f8671dcec 100644 --- a/sphinx/builders/html/transforms.py +++ b/sphinx/builders/html/transforms.py @@ -1,5 +1,4 @@ -""" - Transforms for HTML builder. +"""Transforms for HTML builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index 78063eee4..ba71eba64 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -1,5 +1,4 @@ -""" - LaTeX builder. +"""LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py index 1e939a46c..ace27d6a7 100644 --- a/sphinx/builders/latex/constants.py +++ b/sphinx/builders/latex/constants.py @@ -1,5 +1,4 @@ -""" - consntants for LaTeX builder. +"""consntants for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/nodes.py b/sphinx/builders/latex/nodes.py index 30c729941..51fed2a9b 100644 --- a/sphinx/builders/latex/nodes.py +++ b/sphinx/builders/latex/nodes.py @@ -1,5 +1,4 @@ -""" - Additional nodes for LaTeX writer. +"""Additional nodes for LaTeX writer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/theming.py b/sphinx/builders/latex/theming.py index a465cb209..434688841 100644 --- a/sphinx/builders/latex/theming.py +++ b/sphinx/builders/latex/theming.py @@ -1,5 +1,4 @@ -""" - Theming support for LaTeX builder. +"""Theming support for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py index 3309b891d..0dbaed100 100644 --- a/sphinx/builders/latex/transforms.py +++ b/sphinx/builders/latex/transforms.py @@ -1,5 +1,4 @@ -""" - Transforms for LaTeX builder. +"""Transforms for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/util.py b/sphinx/builders/latex/util.py index da1f79653..34fff7fcc 100644 --- a/sphinx/builders/latex/util.py +++ b/sphinx/builders/latex/util.py @@ -1,5 +1,4 @@ -""" - Utilities for LaTeX builder. +"""Utilities for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index e6621a254..036b26836 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -1,5 +1,4 @@ -""" - The CheckExternalLinksBuilder class. +"""The CheckExternalLinksBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index 59870809e..76772d873 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -1,5 +1,4 @@ -""" - Manual pages builder. +"""Manual pages builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py index 0c4daf8a4..0d65a0bcd 100644 --- a/sphinx/builders/singlehtml.py +++ b/sphinx/builders/singlehtml.py @@ -1,5 +1,4 @@ -""" - Single HTML builders. +"""Single HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index 56448b638..431cec29e 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -1,5 +1,4 @@ -""" - Texinfo builder. +"""Texinfo builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index 038ae4ba0..4f400f577 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -1,5 +1,4 @@ -""" - Plain-text Sphinx builder. +"""Plain-text Sphinx builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py index 873cc34d5..d3701f00a 100644 --- a/sphinx/builders/xml.py +++ b/sphinx/builders/xml.py @@ -1,5 +1,4 @@ -""" - Docutils-native XML and pseudo-XML builders. +"""Docutils-native XML and pseudo-XML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/cmd/__init__.py b/sphinx/cmd/__init__.py index 717893f69..2ef622e26 100644 --- a/sphinx/cmd/__init__.py +++ b/sphinx/cmd/__init__.py @@ -1,5 +1,4 @@ -""" - Modules for command line executables. +"""Modules for command line executables. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index e135cf385..16c9a6274 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -1,5 +1,4 @@ -""" - Build documentation from a provided source. +"""Build documentation from a provided source. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/cmd/make_mode.py b/sphinx/cmd/make_mode.py index a08b673ad..c8e694954 100644 --- a/sphinx/cmd/make_mode.py +++ b/sphinx/cmd/make_mode.py @@ -1,5 +1,4 @@ -""" - sphinx-build -M command-line handling. +"""sphinx-build -M command-line handling. This replaces the old, platform-dependent and once-generated content of Makefile / make.bat. diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index c5e3ebb52..addb4c621 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -1,5 +1,4 @@ -""" - Quickly setup documentation source to work with Sphinx. +"""Quickly setup documentation source to work with Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/config.py b/sphinx/config.py index 32daedcec..eabc79425 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -1,5 +1,4 @@ -""" - Build configuration file handling. +"""Build configuration file handling. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py index 10ff34658..7ee5b1773 100644 --- a/sphinx/deprecation.py +++ b/sphinx/deprecation.py @@ -1,5 +1,4 @@ -""" - Sphinx deprecation classes and utilities. +"""Sphinx deprecation classes and utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index 1b4a992b9..5bd57d9cd 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -1,5 +1,4 @@ -""" - Handlers for additional ReST directives. +"""Handlers for additional ReST directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py index 6e702b86e..6942def51 100644 --- a/sphinx/domains/__init__.py +++ b/sphinx/domains/__init__.py @@ -1,5 +1,4 @@ -""" - Support for domains, which are groupings of description directives +"""Support for domains, which are groupings of description directives and roles describing e.g. constructs of one programming language. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index c79173e01..41742a624 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -1,5 +1,4 @@ -""" - The C language domain. +"""The C language domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index 817f35487..91cf7412f 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -1,5 +1,4 @@ -""" - The changeset domain. +"""The changeset domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/citation.py b/sphinx/domains/citation.py index a3b5bc04b..897d5b46a 100644 --- a/sphinx/domains/citation.py +++ b/sphinx/domains/citation.py @@ -1,5 +1,4 @@ -""" - The citation domain. +"""The citation domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index a9fe0d967..7d4b19db8 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1,5 +1,4 @@ -""" - The C++ language domain. +"""The C++ language domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/index.py b/sphinx/domains/index.py index 961b590f4..e5ca1fa11 100644 --- a/sphinx/domains/index.py +++ b/sphinx/domains/index.py @@ -1,5 +1,4 @@ -""" - The index domain. +"""The index domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 5c30c2180..68303d8eb 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -1,5 +1,4 @@ -""" - The JavaScript domain. +"""The JavaScript domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py index f4db6a6b7..ce7df96a1 100644 --- a/sphinx/domains/math.py +++ b/sphinx/domains/math.py @@ -1,5 +1,4 @@ -""" - The math domain. +"""The math domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index e927b959d..6cd7af93c 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -1,5 +1,4 @@ -""" - The Python domain. +"""The Python domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py index 40f69dee3..549818d03 100644 --- a/sphinx/domains/rst.py +++ b/sphinx/domains/rst.py @@ -1,5 +1,4 @@ -""" - The reStructuredText domain. +"""The reStructuredText domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index 8187abd4b..b0a2e6bfc 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -1,5 +1,4 @@ -""" - The standard domain. +"""The standard domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index bbe4bf2b7..df75296f6 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -1,5 +1,4 @@ -""" - Global creation environment. +"""Global creation environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/adapters/__init__.py b/sphinx/environment/adapters/__init__.py index 2fd847357..3df72b665 100644 --- a/sphinx/environment/adapters/__init__.py +++ b/sphinx/environment/adapters/__init__.py @@ -1,5 +1,4 @@ -""" - Sphinx environment adapters +"""Sphinx environment adapters :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/adapters/asset.py b/sphinx/environment/adapters/asset.py index 63e736ff7..a633d4e5d 100644 --- a/sphinx/environment/adapters/asset.py +++ b/sphinx/environment/adapters/asset.py @@ -1,5 +1,4 @@ -""" - Assets adapter for sphinx.environment. +"""Assets adapter for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/adapters/indexentries.py b/sphinx/environment/adapters/indexentries.py index 28d56e1c8..66689ab91 100644 --- a/sphinx/environment/adapters/indexentries.py +++ b/sphinx/environment/adapters/indexentries.py @@ -1,5 +1,4 @@ -""" - Index entries adapters for sphinx.environment. +"""Index entries adapters for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index 1c27fa705..6186f6f1d 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/sphinx/environment/adapters/toctree.py @@ -1,5 +1,4 @@ -""" - Toctree adapter for sphinx.environment. +"""Toctree adapter for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/__init__.py b/sphinx/environment/collectors/__init__.py index badc0bac0..6126a883f 100644 --- a/sphinx/environment/collectors/__init__.py +++ b/sphinx/environment/collectors/__init__.py @@ -1,5 +1,4 @@ -""" - The data collector components for sphinx.environment. +"""The data collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/asset.py b/sphinx/environment/collectors/asset.py index fd51061b9..d98bfde53 100644 --- a/sphinx/environment/collectors/asset.py +++ b/sphinx/environment/collectors/asset.py @@ -1,5 +1,4 @@ -""" - The image collector for sphinx.environment. +"""The image collector for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/dependencies.py b/sphinx/environment/collectors/dependencies.py index d1ce80a73..0512e6fd4 100644 --- a/sphinx/environment/collectors/dependencies.py +++ b/sphinx/environment/collectors/dependencies.py @@ -1,5 +1,4 @@ -""" - The dependencies collector components for sphinx.environment. +"""The dependencies collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/metadata.py b/sphinx/environment/collectors/metadata.py index 34bfb49cd..67172b973 100644 --- a/sphinx/environment/collectors/metadata.py +++ b/sphinx/environment/collectors/metadata.py @@ -1,5 +1,4 @@ -""" - The metadata collector components for sphinx.environment. +"""The metadata collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/title.py b/sphinx/environment/collectors/title.py index 1ef53514d..df875d0e2 100644 --- a/sphinx/environment/collectors/title.py +++ b/sphinx/environment/collectors/title.py @@ -1,5 +1,4 @@ -""" - The title collector components for sphinx.environment. +"""The title collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/toctree.py b/sphinx/environment/collectors/toctree.py index dc39ee254..c53ee6129 100644 --- a/sphinx/environment/collectors/toctree.py +++ b/sphinx/environment/collectors/toctree.py @@ -1,5 +1,4 @@ -""" - Toctree collector for sphinx.environment. +"""Toctree collector for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/errors.py b/sphinx/errors.py index f89804c7f..e0aab4b05 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,5 +1,4 @@ -""" - Contains SphinxError and a few subclasses (in an extra module to avoid +"""Contains SphinxError and a few subclasses (in an extra module to avoid circular import problems). :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/events.py b/sphinx/events.py index 5a95416fc..cb4d1f7d2 100644 --- a/sphinx/events.py +++ b/sphinx/events.py @@ -1,5 +1,4 @@ -""" - Sphinx core events. +"""Sphinx core events. Gracefully adapted from the TextPress system by Armin. diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py index a97bab5bf..4d293c049 100644 --- a/sphinx/ext/__init__.py +++ b/sphinx/ext/__init__.py @@ -1,5 +1,4 @@ -""" - Contains Sphinx features not activated by default. +"""Contains Sphinx features not activated by default. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py index bb1e582eb..c6ad9e984 100644 --- a/sphinx/ext/apidoc.py +++ b/sphinx/ext/apidoc.py @@ -1,5 +1,4 @@ -""" - Parses a directory tree looking for Python modules and packages and creates +"""Parses a directory tree looking for Python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index (named modules.). diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 6d19e6eee..69dc1533a 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1,5 +1,4 @@ -""" - Automatically insert docstrings for functions, classes or whole modules into +"""Automatically insert docstrings for functions, classes or whole modules into the doctree, thus avoiding duplication between docstrings and documentation for those who like elaborate docstrings. diff --git a/sphinx/ext/autodoc/deprecated.py b/sphinx/ext/autodoc/deprecated.py index 63e2c307b..740c87b80 100644 --- a/sphinx/ext/autodoc/deprecated.py +++ b/sphinx/ext/autodoc/deprecated.py @@ -1,5 +1,4 @@ -""" - The deprecated Documenters for autodoc. +"""The deprecated Documenters for autodoc. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py index dfa088f2a..3f4810a14 100644 --- a/sphinx/ext/autodoc/importer.py +++ b/sphinx/ext/autodoc/importer.py @@ -1,5 +1,4 @@ -""" - Importer utilities for autodoc +"""Importer utilities for autodoc :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py index 759c5bae1..aafb3f8c2 100644 --- a/sphinx/ext/autodoc/mock.py +++ b/sphinx/ext/autodoc/mock.py @@ -1,5 +1,4 @@ -""" - mock for autodoc +"""mock for autodoc :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autodoc/preserve_defaults.py b/sphinx/ext/autodoc/preserve_defaults.py index 9b5d76204..8cde4d08f 100644 --- a/sphinx/ext/autodoc/preserve_defaults.py +++ b/sphinx/ext/autodoc/preserve_defaults.py @@ -1,5 +1,4 @@ -""" - Preserve the default argument values of function signatures in source code +"""Preserve the default argument values of function signatures in source code and keep them not evaluated for readability. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autodoc/type_comment.py b/sphinx/ext/autodoc/type_comment.py index e4483842d..f8cfa334a 100644 --- a/sphinx/ext/autodoc/type_comment.py +++ b/sphinx/ext/autodoc/type_comment.py @@ -1,5 +1,4 @@ -""" - Update annotations info of living objects using type_comments. +"""Update annotations info of living objects using type_comments. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py index 6b4188d22..ccdbfb2b0 100644 --- a/sphinx/ext/autodoc/typehints.py +++ b/sphinx/ext/autodoc/typehints.py @@ -1,5 +1,4 @@ -""" - Generating content for autodoc using typehints +"""Generating content for autodoc using typehints :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py index 944d2d4cc..5341248fc 100644 --- a/sphinx/ext/autosectionlabel.py +++ b/sphinx/ext/autosectionlabel.py @@ -1,5 +1,4 @@ -""" - Allow reference sections by :ref: role using its title. +"""Allow reference sections by :ref: role using its title. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index c18a71d70..1c7bce8cd 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -1,5 +1,4 @@ -""" - Sphinx extension that adds an autosummary:: directive, which can be +"""Sphinx extension that adds an autosummary:: directive, which can be used to generate function/method/attribute/etc. summary lists, similar to those output eg. by Epydoc and other API doc generation tools. diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index ff67a25e8..00f343da8 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -1,5 +1,4 @@ -""" - Usable as a library or script to generate automatic RST source files for +"""Usable as a library or script to generate automatic RST source files for items referred to in autosummary:: directives. Each generated RST file contains a single auto*:: directive which diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index 652bc5c0f..6fd1b1fdc 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -1,5 +1,4 @@ -""" - Check Python modules and C API for coverage. Mostly written by Josip +"""Check Python modules and C API for coverage. Mostly written by Josip Dzolonga for the Google Highly Open Participation contest. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index af6da43e0..94082e78c 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -1,5 +1,4 @@ -""" - Mimic doctest by automatically executing code snippets and checking +"""Mimic doctest by automatically executing code snippets and checking their results. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py index 6e918b134..8e624f24c 100644 --- a/sphinx/ext/duration.py +++ b/sphinx/ext/duration.py @@ -1,5 +1,4 @@ -""" - Measure durations of Sphinx processing. +"""Measure durations of Sphinx processing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py index 58ed9674b..ba886b837 100644 --- a/sphinx/ext/extlinks.py +++ b/sphinx/ext/extlinks.py @@ -1,5 +1,4 @@ -""" - Extension to save typing and prevent hard-coding of base URLs in the reST +"""Extension to save typing and prevent hard-coding of base URLs in the reST files. This adds a new config value called ``extlinks`` that is created like this:: diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py index cb2584d8d..a59fde913 100644 --- a/sphinx/ext/githubpages.py +++ b/sphinx/ext/githubpages.py @@ -1,5 +1,4 @@ -""" - To publish HTML docs at GitHub Pages, create .nojekyll file. +"""To publish HTML docs at GitHub Pages, create .nojekyll file. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index e5749d143..6e2e8958d 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -1,5 +1,4 @@ -""" - Allow graphviz-formatted graphs to be included in Sphinx-generated +"""Allow graphviz-formatted graphs to be included in Sphinx-generated documents inline. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 44f218f3d..f46241409 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -1,5 +1,4 @@ -""" - Provides the ``ifconfig`` directive that allows to write documentation +"""Provides the ``ifconfig`` directive that allows to write documentation that is included depending on configuration variables. Usage:: diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index 2117e7130..e5582de4b 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -1,5 +1,4 @@ -""" - Image converter extension for Sphinx +"""Image converter extension for Sphinx :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index bdabc8634..47ba9d927 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -1,5 +1,4 @@ -""" - Render math in HTML via dvipng or dvisvgm. +"""Render math in HTML via dvipng or dvisvgm. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index e1fd2a237..1afd6c5ab 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -1,5 +1,4 @@ -r""" - Defines a docutils directive for inserting inheritance diagrams. +r"""Defines a docutils directive for inserting inheritance diagrams. Provide the directive with one or more classes or modules (separated by whitespace). For modules, all of the classes in that module will diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index eacc72f85..ad27fd4cf 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -1,5 +1,4 @@ -""" - Insert links to objects documented in remote Sphinx documentation. +"""Insert links to objects documented in remote Sphinx documentation. This works as follows: diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index d724e3551..2f6c73846 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -1,5 +1,4 @@ -""" - Add external links to module code in Python object descriptions. +"""Add external links to module code in Python object descriptions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index c641b11ea..d2c7affcb 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -1,5 +1,4 @@ -""" - Allow `MathJax `_ to be used to display math in +"""Allow `MathJax `_ to be used to display math in Sphinx's HTML writer -- requires the MathJax JavaScript library on your webserver/computer. diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index 07e165ec6..cc1ec3638 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -1,5 +1,4 @@ -""" - Support for NumPy and Google style docstrings. +"""Support for NumPy and Google style docstrings. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index 7c1df2c69..4e06aee5a 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -1,5 +1,4 @@ -""" - Allow todos to be inserted into your documentation. Inclusion of todos can +"""Allow todos to be inserted into your documentation. Inclusion of todos can be switched of by a configuration variable. The todolist directive collects all todos of your project and lists them along with a backlink to the original location. diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 5fd6120c0..fb6b3df10 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -1,5 +1,4 @@ -""" - Add links to module code in Python object descriptions. +"""Add links to module code in Python object descriptions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/extension.py b/sphinx/extension.py index 0188dab17..584ce6add 100644 --- a/sphinx/extension.py +++ b/sphinx/extension.py @@ -1,5 +1,4 @@ -""" - Utilities for Sphinx extensions. +"""Utilities for Sphinx extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 37e1cdf17..3580b3efb 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -1,5 +1,4 @@ -""" - Highlight code blocks using Pygments. +"""Highlight code blocks using Pygments. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/io.py b/sphinx/io.py index 7d8bd87a9..63c04168e 100644 --- a/sphinx/io.py +++ b/sphinx/io.py @@ -1,5 +1,4 @@ -""" - Input/Output files +"""Input/Output files :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index c61ad8cf8..dbc5cab8b 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -1,5 +1,4 @@ -""" - Glue code for the jinja2 templating engine. +"""Glue code for the jinja2 templating engine. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py index b0e579d3b..dabba8519 100644 --- a/sphinx/locale/__init__.py +++ b/sphinx/locale/__init__.py @@ -1,5 +1,4 @@ -""" - Locale utilities. +"""Locale utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/parsers.py b/sphinx/parsers.py index 471c27274..ee1be5b10 100644 --- a/sphinx/parsers.py +++ b/sphinx/parsers.py @@ -1,5 +1,4 @@ -""" - A Base class for additional parsers. +"""A Base class for additional parsers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/project.py b/sphinx/project.py index 47559d7b8..c8d7fc9dd 100644 --- a/sphinx/project.py +++ b/sphinx/project.py @@ -1,5 +1,4 @@ -""" - Utility function and classes for Sphinx projects. +"""Utility function and classes for Sphinx projects. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index 66f506795..0188e9bcb 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -1,5 +1,4 @@ -""" - Utilities parsing and analyzing Python code. +"""Utilities parsing and analyzing Python code. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py index 07c85bf11..8c8f65d8b 100644 --- a/sphinx/pycode/ast.py +++ b/sphinx/pycode/ast.py @@ -1,5 +1,4 @@ -""" - Helpers for AST (Abstract Syntax Tree). +"""Helpers for AST (Abstract Syntax Tree). :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py index 2265dd2ac..e47b229a1 100644 --- a/sphinx/pycode/parser.py +++ b/sphinx/pycode/parser.py @@ -1,5 +1,4 @@ -""" - Utilities parsing and analyzing Python code. +"""Utilities parsing and analyzing Python code. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py index 37bd872bc..ac3556194 100644 --- a/sphinx/pygments_styles.py +++ b/sphinx/pygments_styles.py @@ -1,5 +1,4 @@ -""" - Sphinx theme specific highlighting styles. +"""Sphinx theme specific highlighting styles. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/registry.py b/sphinx/registry.py index e928bb4db..59638c9a1 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -1,5 +1,4 @@ -""" - Sphinx component registry. +"""Sphinx component registry. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/roles.py b/sphinx/roles.py index 177b7c61b..4c8fa2c8a 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -1,5 +1,4 @@ -""" - Handlers for additional ReST roles. +"""Handlers for additional ReST roles. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index c569aa797..15fffd003 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -1,5 +1,4 @@ -""" - Create a full-text search index for offline search. +"""Create a full-text search index for offline search. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/da.py b/sphinx/search/da.py index 275555136..de20b45d4 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -1,5 +1,4 @@ -""" - Danish search language: includes the JS Danish stemmer. +"""Danish search language: includes the JS Danish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/de.py b/sphinx/search/de.py index af02d12dd..05b3eeaee 100644 --- a/sphinx/search/de.py +++ b/sphinx/search/de.py @@ -1,5 +1,4 @@ -""" - German search language: includes the JS German stemmer. +"""German search language: includes the JS German stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/en.py b/sphinx/search/en.py index c6667c530..b6e4b31ed 100644 --- a/sphinx/search/en.py +++ b/sphinx/search/en.py @@ -1,5 +1,4 @@ -""" - English search language: includes the JS porter stemmer. +"""English search language: includes the JS porter stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/es.py b/sphinx/search/es.py index 3026c9fd4..1bee7fbf7 100644 --- a/sphinx/search/es.py +++ b/sphinx/search/es.py @@ -1,5 +1,4 @@ -""" - Spanish search language: includes the JS Spanish stemmer. +"""Spanish search language: includes the JS Spanish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py index bda7159f0..a632ad647 100644 --- a/sphinx/search/fi.py +++ b/sphinx/search/fi.py @@ -1,5 +1,4 @@ -""" - Finnish search language: includes the JS Finnish stemmer. +"""Finnish search language: includes the JS Finnish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py index 4692a64e3..19be35946 100644 --- a/sphinx/search/fr.py +++ b/sphinx/search/fr.py @@ -1,5 +1,4 @@ -""" - French search language: includes the JS French stemmer. +"""French search language: includes the JS French stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py index 0d0c28e50..821aabcf9 100644 --- a/sphinx/search/hu.py +++ b/sphinx/search/hu.py @@ -1,5 +1,4 @@ -""" - Hungarian search language: includes the JS Hungarian stemmer. +"""Hungarian search language: includes the JS Hungarian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/it.py b/sphinx/search/it.py index 9ec7768ed..e751a17a1 100644 --- a/sphinx/search/it.py +++ b/sphinx/search/it.py @@ -1,5 +1,4 @@ -""" - Italian search language: includes the JS Italian stemmer. +"""Italian search language: includes the JS Italian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index 820de07f1..fab0595da 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -1,5 +1,4 @@ -""" - Japanese search language: includes routine to split words. +"""Japanese search language: includes routine to split words. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/jssplitter.py b/sphinx/search/jssplitter.py index 13f55a16e..c4fe62737 100644 --- a/sphinx/search/jssplitter.py +++ b/sphinx/search/jssplitter.py @@ -1,5 +1,4 @@ -""" - Provides Python compatible word splitter to JavaScript +"""Provides Python compatible word splitter to JavaScript DO NOT EDIT. This is generated by utils/jssplitter_generator.py diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py index 06c84ce4d..a7989b1ed 100644 --- a/sphinx/search/nl.py +++ b/sphinx/search/nl.py @@ -1,5 +1,4 @@ -""" - Dutch search language: includes the JS porter stemmer. +"""Dutch search language: includes the JS porter stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/no.py b/sphinx/search/no.py index 1208991cb..c30352530 100644 --- a/sphinx/search/no.py +++ b/sphinx/search/no.py @@ -1,5 +1,4 @@ -""" - Norwegian search language: includes the JS Norwegian stemmer. +"""Norwegian search language: includes the JS Norwegian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py index 46a4bb0d0..994daebe7 100644 --- a/sphinx/search/pt.py +++ b/sphinx/search/pt.py @@ -1,5 +1,4 @@ -""" - Portuguese search language: includes the JS Portuguese stemmer. +"""Portuguese search language: includes the JS Portuguese stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/ro.py b/sphinx/search/ro.py index 817c70165..bbc5e9326 100644 --- a/sphinx/search/ro.py +++ b/sphinx/search/ro.py @@ -1,5 +1,4 @@ -""" - Romanian search language: includes the JS Romanian stemmer. +"""Romanian search language: includes the JS Romanian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index f2e027592..53dd64e83 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -1,5 +1,4 @@ -""" - Russian search language: includes the JS Russian stemmer. +"""Russian search language: includes the JS Russian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py index c7b0fde93..0ee635416 100644 --- a/sphinx/search/sv.py +++ b/sphinx/search/sv.py @@ -1,5 +1,4 @@ -""" - Swedish search language: includes the JS Swedish stemmer. +"""Swedish search language: includes the JS Swedish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/tr.py b/sphinx/search/tr.py index c85912337..75eca4731 100644 --- a/sphinx/search/tr.py +++ b/sphinx/search/tr.py @@ -1,5 +1,4 @@ -""" - Turkish search language: includes the JS Turkish stemmer. +"""Turkish search language: includes the JS Turkish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/zh.py b/sphinx/search/zh.py index 276a49a70..712fdf63b 100644 --- a/sphinx/search/zh.py +++ b/sphinx/search/zh.py @@ -1,5 +1,4 @@ -""" - Chinese search language: includes routine to split words. +"""Chinese search language: includes routine to split words. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index 3d9663d0f..80914373a 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -1,5 +1,4 @@ -""" - Setuptools/distutils commands to assist the building of sphinx +"""Setuptools/distutils commands to assist the building of sphinx documentation. :author: Sebastian Wiesner diff --git a/sphinx/testing/__init__.py b/sphinx/testing/__init__.py index babfde1f5..7798e69f7 100644 --- a/sphinx/testing/__init__.py +++ b/sphinx/testing/__init__.py @@ -1,5 +1,4 @@ -""" - Sphinx test utilities +"""Sphinx test utilities You can require sphinx.testing pytest fixtures in a test module or a conftest file like this: diff --git a/sphinx/testing/comparer.py b/sphinx/testing/comparer.py index 577a4d091..e102a52c9 100644 --- a/sphinx/testing/comparer.py +++ b/sphinx/testing/comparer.py @@ -1,5 +1,4 @@ -""" - Sphinx test comparer for pytest +"""Sphinx test comparer for pytest :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py index 69233707c..15ecfb39c 100644 --- a/sphinx/testing/fixtures.py +++ b/sphinx/testing/fixtures.py @@ -1,5 +1,4 @@ -""" - Sphinx test fixtures for pytest +"""Sphinx test fixtures for pytest :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py index 197e802ed..a1b4b8601 100644 --- a/sphinx/testing/util.py +++ b/sphinx/testing/util.py @@ -1,5 +1,4 @@ -""" - Sphinx test suite utilities +"""Sphinx test suite utilities :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/theming.py b/sphinx/theming.py index c4cfad77a..1931424d8 100644 --- a/sphinx/theming.py +++ b/sphinx/theming.py @@ -1,5 +1,4 @@ -""" - Theming support for HTML builders. +"""Theming support for HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py index ab23f7b4e..60d1c2436 100644 --- a/sphinx/transforms/__init__.py +++ b/sphinx/transforms/__init__.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx when reading documents. +"""Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py index c1dfee0d8..7bcdb515c 100644 --- a/sphinx/transforms/compact_bullet_list.py +++ b/sphinx/transforms/compact_bullet_list.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx when reading documents. +"""Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py index 6a80daf08..62e75fa24 100644 --- a/sphinx/transforms/i18n.py +++ b/sphinx/transforms/i18n.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx when reading documents. +"""Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py index 720807118..5595ad4b7 100644 --- a/sphinx/transforms/post_transforms/__init__.py +++ b/sphinx/transforms/post_transforms/__init__.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx. +"""Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index 0deda5ed0..3af3b21c7 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -1,5 +1,4 @@ -""" - transforms for code-blocks. +"""transforms for code-blocks. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py index 6c265a470..d7149c0c2 100644 --- a/sphinx/transforms/post_transforms/images.py +++ b/sphinx/transforms/post_transforms/images.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx. +"""Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py index b47fb545b..ed7a0b472 100644 --- a/sphinx/transforms/references.py +++ b/sphinx/transforms/references.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx. +"""Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 554ade0cb..d6454735d 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -1,5 +1,4 @@ -""" - Utility functions for Sphinx. +"""Utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py index 68cdb6a31..4f7bf1a75 100644 --- a/sphinx/util/build_phase.py +++ b/sphinx/util/build_phase.py @@ -1,5 +1,4 @@ -""" - Build phase of Sphinx application. +"""Build phase of Sphinx application. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py index 6b9b05966..0772bee20 100644 --- a/sphinx/util/cfamily.py +++ b/sphinx/util/cfamily.py @@ -1,5 +1,4 @@ -""" - Utility functions common to the C and C++ domains. +"""Utility functions common to the C and C++ domains. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 0f644b838..8d5eed46e 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -1,5 +1,4 @@ -""" - modules for backward compatibility +"""modules for backward compatibility :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/console.py b/sphinx/util/console.py index 62e4d297e..b391d524b 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -1,5 +1,4 @@ -""" - Format colored console output. +"""Format colored console output. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index f81f80948..adabab9c8 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -1,5 +1,4 @@ -""" - "Doc fields" are reST field lists in object descriptions that will +""""Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index f634b438b..57ae47e86 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,5 +1,4 @@ -""" - Utilities for docstring processing. +"""Utilities for docstring processing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index 90f00ddd5..64726fcee 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -1,5 +1,4 @@ -""" - Utility functions for docutils. +"""Utility functions for docutils. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py index 7e412e2ec..e633f77bd 100644 --- a/sphinx/util/fileutil.py +++ b/sphinx/util/fileutil.py @@ -1,5 +1,4 @@ -""" - File utility functions for Sphinx. +"""File utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py index 0e0621fcd..5e5cbec8a 100644 --- a/sphinx/util/i18n.py +++ b/sphinx/util/i18n.py @@ -1,5 +1,4 @@ -""" - Builder superclass for all builders. +"""Builder superclass for all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/images.py b/sphinx/util/images.py index 508617ca6..05572ec29 100644 --- a/sphinx/util/images.py +++ b/sphinx/util/images.py @@ -1,5 +1,4 @@ -""" - Image utility functions for Sphinx. +"""Image utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 9a66c0ec6..2d6aac13b 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -1,5 +1,4 @@ -""" - Helpers for inspecting Python modules. +"""Helpers for inspecting Python modules. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py index dfc3cd7ba..e8e5e480e 100644 --- a/sphinx/util/inventory.py +++ b/sphinx/util/inventory.py @@ -1,5 +1,4 @@ -""" - Inventory utility functions for Sphinx. +"""Inventory utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index 935a26119..0cad261ce 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -1,5 +1,4 @@ -""" - This module implements a simple JavaScript serializer. +"""This module implements a simple JavaScript serializer. Uses the basestring encode function from simplejson by Bob Ippolito. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py index b78707afe..a0c09bb20 100644 --- a/sphinx/util/logging.py +++ b/sphinx/util/logging.py @@ -1,5 +1,4 @@ -""" - Logging utility functions for Sphinx. +"""Logging utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index e8c000ee1..c84cd757f 100644 --- a/sphinx/util/matching.py +++ b/sphinx/util/matching.py @@ -1,5 +1,4 @@ -""" - Pattern-matching utility functions for Sphinx. +"""Pattern-matching utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/math.py b/sphinx/util/math.py index 0fa945890..0addaa5a0 100644 --- a/sphinx/util/math.py +++ b/sphinx/util/math.py @@ -1,5 +1,4 @@ -""" - Utility functions for math. +"""Utility functions for math. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index 3af9f4dd7..b19597041 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -1,5 +1,4 @@ -""" - Docutils node-related utility functions for Sphinx. +"""Docutils node-related utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index e346170f0..e0d736229 100644 --- a/sphinx/util/osutil.py +++ b/sphinx/util/osutil.py @@ -1,5 +1,4 @@ -""" - Operating system-related utility functions for Sphinx. +"""Operating system-related utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index 3783db7fc..5a63fb9e9 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -1,5 +1,4 @@ -""" - Parallel building utilities. +"""Parallel building utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/png.py b/sphinx/util/png.py index ba9794f62..cb0f86eb9 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -1,5 +1,4 @@ -""" - PNG image manipulation helpers. +"""PNG image manipulation helpers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index 639ccb5ab..a8b105cc7 100644 --- a/sphinx/util/pycompat.py +++ b/sphinx/util/pycompat.py @@ -1,5 +1,4 @@ -""" - Stuff for Python version compatibility. +"""Stuff for Python version compatibility. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py index 78b947ce8..8241bc60b 100644 --- a/sphinx/util/requests.py +++ b/sphinx/util/requests.py @@ -1,5 +1,4 @@ -""" - Simple requests package loader +"""Simple requests package loader :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index 3cb9d64ba..8b0f05507 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -1,5 +1,4 @@ -""" - reST helper functions. +"""reST helper functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/smartypants.py b/sphinx/util/smartypants.py index 512ab839a..363a4c97b 100644 --- a/sphinx/util/smartypants.py +++ b/sphinx/util/smartypants.py @@ -1,5 +1,4 @@ -""" - This is extracted (with minor adaptations for flake8 compliance) from +"""This is extracted (with minor adaptations for flake8 compliance) from docutils’ docutils/utils/smartquotes.py as of revision 8097 (30 May 2017), in order to backport for Sphinx usage with Docutils < 0.14 extra language configurations and fixes. Replaces earlier smartypants version as used up diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py index 0332e3f3b..d7576a94e 100644 --- a/sphinx/util/stemmer/__init__.py +++ b/sphinx/util/stemmer/__init__.py @@ -1,5 +1,4 @@ -""" - Word stemming utilities for Sphinx. +"""Word stemming utilities for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/stemmer/porter.py b/sphinx/util/stemmer/porter.py index e26431646..6068e76ab 100644 --- a/sphinx/util/stemmer/porter.py +++ b/sphinx/util/stemmer/porter.py @@ -1,5 +1,4 @@ -""" - Porter Stemming Algorithm +"""Porter Stemming Algorithm This is the Porter stemming algorithm, ported to Python from the version coded up in ANSI C by the author. It may be be regarded diff --git a/sphinx/util/template.py b/sphinx/util/template.py index c684b8589..2fcd1f245 100644 --- a/sphinx/util/template.py +++ b/sphinx/util/template.py @@ -1,5 +1,4 @@ -""" - Templates utility functions for Sphinx. +"""Templates utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index 92b07521f..c9e421022 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -1,5 +1,4 @@ -""" - TeX escaping helper. +"""TeX escaping helper. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py index df5c9f6e8..0cffd94ff 100644 --- a/sphinx/util/typing.py +++ b/sphinx/util/typing.py @@ -1,5 +1,4 @@ -""" - The composite types for Sphinx. +"""The composite types for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/versioning.py b/sphinx/versioning.py index 09be9aef7..1d7eca5c6 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -1,5 +1,4 @@ -""" - Implements the low-level algorithms Sphinx uses for the versioning of +"""Implements the low-level algorithms Sphinx uses for the versioning of doctrees. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py index 668ecc0f5..711c568df 100644 --- a/sphinx/writers/__init__.py +++ b/sphinx/writers/__init__.py @@ -1,5 +1,4 @@ -""" - Custom docutils writers. +"""Custom docutils writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index e7efff848..08e142650 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -1,5 +1,4 @@ -""" - docutils writers handling Sphinx' custom nodes. +"""docutils writers handling Sphinx' custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index 5324741cd..1e911c8f8 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -1,5 +1,4 @@ -""" - Experimental docutils writers for HTML5 handling Sphinx's custom nodes. +"""Experimental docutils writers for HTML5 handling Sphinx's custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 7956a854d..efabba313 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -1,5 +1,4 @@ -""" - Custom docutils writer for LaTeX. +"""Custom docutils writer for LaTeX. Much of this code is adapted from Dave Kuhlman's "docpy" writer from his docutils sandbox. diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index be7a405b7..1ed8463e8 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -1,5 +1,4 @@ -""" - Manual page writer, extended for Sphinx custom nodes. +"""Manual page writer, extended for Sphinx custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index 7b7af182d..e307a36a6 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -1,5 +1,4 @@ -""" - Custom docutils writer for Texinfo. +"""Custom docutils writer for Texinfo. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 255beb848..57aa765cd 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -1,5 +1,4 @@ -""" - Custom docutils writer for plain text. +"""Custom docutils writer for plain text. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py index 733b6b3a2..f372db024 100644 --- a/sphinx/writers/xml.py +++ b/sphinx/writers/xml.py @@ -1,5 +1,4 @@ -""" - Docutils-native XML and pseudo-XML writers. +"""Docutils-native XML and pseudo-XML writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/roots/test-inheritance/dummy/test_nested.py b/tests/roots/test-inheritance/dummy/test_nested.py index 1e732aab5..89289fe44 100644 --- a/tests/roots/test-inheritance/dummy/test_nested.py +++ b/tests/roots/test-inheritance/dummy/test_nested.py @@ -1,5 +1,4 @@ -""" - Test with nested classes. +"""Test with nested classes. """ diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py index 303387156..26d85df80 100644 --- a/tests/test_api_translator.py +++ b/tests/test_api_translator.py @@ -1,5 +1,4 @@ -""" - Test the Sphinx API for translator. +"""Test the Sphinx API for translator. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_application.py b/tests/test_application.py index 5eac1f7d0..00b6e7d88 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -1,5 +1,4 @@ -""" - Test the Sphinx class. +"""Test the Sphinx class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build.py b/tests/test_build.py index c5a34280d..87e16dadd 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -1,5 +1,4 @@ -""" - Test all builders. +"""Test all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_changes.py b/tests/test_build_changes.py index 67fe3701d..7b2b1528f 100644 --- a/tests/test_build_changes.py +++ b/tests/test_build_changes.py @@ -1,5 +1,4 @@ -""" - Test the ChangesBuilder class. +"""Test the ChangesBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_dirhtml.py b/tests/test_build_dirhtml.py index cb3958b7d..7cf865adc 100644 --- a/tests/test_build_dirhtml.py +++ b/tests/test_build_dirhtml.py @@ -1,5 +1,4 @@ -""" - Test dirhtml builder. +"""Test dirhtml builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_epub.py b/tests/test_build_epub.py index ce2610b7b..74b4dcea4 100644 --- a/tests/test_build_epub.py +++ b/tests/test_build_epub.py @@ -1,5 +1,4 @@ -""" - Test the HTML builder and check output against XPath. +"""Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index fd227a6a6..c98ecfa1b 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -1,5 +1,4 @@ -""" - Test the build process with gettext builder with the test root. +"""Test the build process with gettext builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 795e93fac..15cba7888 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -1,5 +1,4 @@ -""" - Test the HTML builder and check output against XPath. +"""Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 5a3dc1811..1ccee9571 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -1,5 +1,4 @@ -""" - Test the build process with LaTeX builder with the test root. +"""Test the build process with LaTeX builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py index f5338020b..2efcd6893 100644 --- a/tests/test_build_linkcheck.py +++ b/tests/test_build_linkcheck.py @@ -1,5 +1,4 @@ -""" - Test the build process with manpage builder with the test root. +"""Test the build process with manpage builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_manpage.py b/tests/test_build_manpage.py index 99b61bb0e..5f92d4783 100644 --- a/tests/test_build_manpage.py +++ b/tests/test_build_manpage.py @@ -1,5 +1,4 @@ -""" - Test the build process with manpage builder with the test root. +"""Test the build process with manpage builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py index 3de24cfe4..1f89a4d63 100644 --- a/tests/test_build_texinfo.py +++ b/tests/test_build_texinfo.py @@ -1,5 +1,4 @@ -""" - Test the build process with Texinfo builder with the test root. +"""Test the build process with Texinfo builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_text.py b/tests/test_build_text.py index 1b1b507a4..9e4789bc5 100644 --- a/tests/test_build_text.py +++ b/tests/test_build_text.py @@ -1,5 +1,4 @@ -""" - Test the build process with Text builder with the test root. +"""Test the build process with Text builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_builder.py b/tests/test_builder.py index cacea6e22..4b6c7d6e1 100644 --- a/tests/test_builder.py +++ b/tests/test_builder.py @@ -1,5 +1,4 @@ -""" - Test the Builder class. +"""Test the Builder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_catalogs.py b/tests/test_catalogs.py index e2c6b9b21..a4e1327af 100644 --- a/tests/test_catalogs.py +++ b/tests/test_catalogs.py @@ -1,5 +1,4 @@ -""" - Test the base build process. +"""Test the base build process. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_config.py b/tests/test_config.py index f64b912c4..56f223a32 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.config.Config class and its handling in the +"""Test the sphinx.config.Config class and its handling in the Application class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_correct_year.py b/tests/test_correct_year.py index 5c219df1d..9214ed9f4 100644 --- a/tests/test_correct_year.py +++ b/tests/test_correct_year.py @@ -1,5 +1,4 @@ -""" - Test copyright year adjustment +"""Test copyright year adjustment :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_directive_code.py b/tests/test_directive_code.py index e7a9d4505..d1f723945 100644 --- a/tests/test_directive_code.py +++ b/tests/test_directive_code.py @@ -1,5 +1,4 @@ -""" - Test the code-block directive. +"""Test the code-block directive. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_directive_only.py b/tests/test_directive_only.py index 29ea531b8..d29e8d72f 100644 --- a/tests/test_directive_only.py +++ b/tests/test_directive_only.py @@ -1,5 +1,4 @@ -""" - Test the only directive with the test root. +"""Test the only directive with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_directive_other.py b/tests/test_directive_other.py index 78118c10a..55e745090 100644 --- a/tests/test_directive_other.py +++ b/tests/test_directive_other.py @@ -1,5 +1,4 @@ -""" - Test the other directives. +"""Test the other directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_directive_patch.py b/tests/test_directive_patch.py index 03f86f61b..31aff4a32 100644 --- a/tests/test_directive_patch.py +++ b/tests/test_directive_patch.py @@ -1,5 +1,4 @@ -""" - Test the patched directives. +"""Test the patched directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py index 342b3180b..7ecd997c4 100644 --- a/tests/test_docutilsconf.py +++ b/tests/test_docutilsconf.py @@ -1,5 +1,4 @@ -""" - Test docutils.conf support for several writers. +"""Test docutils.conf support for several writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_c.py b/tests/test_domain_c.py index d386eb81b..84a4f655d 100644 --- a/tests/test_domain_c.py +++ b/tests/test_domain_c.py @@ -1,5 +1,4 @@ -""" - Tests the C Domain +"""Tests the C Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 6239228e1..0d417c14c 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -1,5 +1,4 @@ -""" - Tests the C++ Domain +"""Tests the C++ Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_js.py b/tests/test_domain_js.py index 592360781..4b4be12e6 100644 --- a/tests/test_domain_js.py +++ b/tests/test_domain_js.py @@ -1,5 +1,4 @@ -""" - Tests the JavaScript Domain +"""Tests the JavaScript Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py index 3ffc3f372..643ec2104 100644 --- a/tests/test_domain_py.py +++ b/tests/test_domain_py.py @@ -1,5 +1,4 @@ -""" - Tests the Python Domain +"""Tests the Python Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_rst.py b/tests/test_domain_rst.py index 231aa6317..43af04f2c 100644 --- a/tests/test_domain_rst.py +++ b/tests/test_domain_rst.py @@ -1,5 +1,4 @@ -""" - Tests the reStructuredText domain. +"""Tests the reStructuredText domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py index 5b5f87ff5..4acc723ab 100644 --- a/tests/test_domain_std.py +++ b/tests/test_domain_std.py @@ -1,5 +1,4 @@ -""" - Tests the std domain +"""Tests the std domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_environment.py b/tests/test_environment.py index 73ea690fa..0a47716ed 100644 --- a/tests/test_environment.py +++ b/tests/test_environment.py @@ -1,5 +1,4 @@ -""" - Test the BuildEnvironment class. +"""Test the BuildEnvironment class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_environment_indexentries.py b/tests/test_environment_indexentries.py index 505b45e8f..3e68ccc90 100644 --- a/tests/test_environment_indexentries.py +++ b/tests/test_environment_indexentries.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.environment.managers.indexentries. +"""Test the sphinx.environment.managers.indexentries. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py index a2a6a3ed9..369050f86 100644 --- a/tests/test_environment_toctree.py +++ b/tests/test_environment_toctree.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.environment.managers.toctree. +"""Test the sphinx.environment.managers.toctree. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_events.py b/tests/test_events.py index 74649a869..071fa13f4 100644 --- a/tests/test_events.py +++ b/tests/test_events.py @@ -1,5 +1,4 @@ -""" - Test the EventManager class. +"""Test the EventManager class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py index 4e4f8d89e..bbddf5278 100644 --- a/tests/test_ext_apidoc.py +++ b/tests/test_ext_apidoc.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.apidoc module. +"""Test the sphinx.apidoc module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py index 3f48beb7a..f4e2c8ef6 100644 --- a/tests/test_ext_autodoc.py +++ b/tests/test_ext_autodoc.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autoattribute.py b/tests/test_ext_autodoc_autoattribute.py index 1907389d3..e8a49c2d4 100644 --- a/tests/test_ext_autodoc_autoattribute.py +++ b/tests/test_ext_autodoc_autoattribute.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autoclass.py b/tests/test_ext_autodoc_autoclass.py index fd90a7cab..649211c05 100644 --- a/tests/test_ext_autodoc_autoclass.py +++ b/tests/test_ext_autodoc_autoclass.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autodata.py b/tests/test_ext_autodoc_autodata.py index 7462e6182..b2fbaac5d 100644 --- a/tests/test_ext_autodoc_autodata.py +++ b/tests/test_ext_autodoc_autodata.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autofunction.py b/tests/test_ext_autodoc_autofunction.py index 30586e08c..474b3f7f3 100644 --- a/tests/test_ext_autodoc_autofunction.py +++ b/tests/test_ext_autodoc_autofunction.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_automodule.py b/tests/test_ext_autodoc_automodule.py index 8aec1fb48..f99d9a364 100644 --- a/tests/test_ext_autodoc_automodule.py +++ b/tests/test_ext_autodoc_automodule.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autoproperty.py b/tests/test_ext_autodoc_autoproperty.py index b967d65b8..033e10ead 100644 --- a/tests/test_ext_autodoc_autoproperty.py +++ b/tests/test_ext_autodoc_autoproperty.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_configs.py b/tests/test_ext_autodoc_configs.py index ce4f0e064..8f5bb10a1 100644 --- a/tests/test_ext_autodoc_configs.py +++ b/tests/test_ext_autodoc_configs.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly for config variables +"""Test the autodoc extension. This tests mainly for config variables :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_events.py b/tests/test_ext_autodoc_events.py index 0adb0d6a1..02d0c739e 100644 --- a/tests/test_ext_autodoc_events.py +++ b/tests/test_ext_autodoc_events.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly for autodoc events +"""Test the autodoc extension. This tests mainly for autodoc events :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_mock.py b/tests/test_ext_autodoc_mock.py index 1a7a39aa0..c2c520457 100644 --- a/tests/test_ext_autodoc_mock.py +++ b/tests/test_ext_autodoc_mock.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. +"""Test the autodoc extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_preserve_defaults.py b/tests/test_ext_autodoc_preserve_defaults.py index 54c26e226..d00d4e774 100644 --- a/tests/test_ext_autodoc_preserve_defaults.py +++ b/tests/test_ext_autodoc_preserve_defaults.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. +"""Test the autodoc extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_private_members.py b/tests/test_ext_autodoc_private_members.py index dbb8f759b..761c48c52 100644 --- a/tests/test_ext_autodoc_private_members.py +++ b/tests/test_ext_autodoc_private_members.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly for private-members option. +"""Test the autodoc extension. This tests mainly for private-members option. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autosectionlabel.py b/tests/test_ext_autosectionlabel.py index 307439e99..0a8732a12 100644 --- a/tests/test_ext_autosectionlabel.py +++ b/tests/test_ext_autosectionlabel.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.autosectionlabel extension. +"""Test sphinx.ext.autosectionlabel extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py index 3bc4d3bd9..0a9a965e0 100644 --- a/tests/test_ext_autosummary.py +++ b/tests/test_ext_autosummary.py @@ -1,5 +1,4 @@ -""" - Test the autosummary extension. +"""Test the autosummary extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_coverage.py b/tests/test_ext_coverage.py index 4c2e799bd..ad96cafbd 100644 --- a/tests/test_ext_coverage.py +++ b/tests/test_ext_coverage.py @@ -1,5 +1,4 @@ -""" - Test the coverage builder. +"""Test the coverage builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index dbda96c15..c1c02fd0e 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -1,5 +1,4 @@ -""" - Test the doctest extension. +"""Test the doctest extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_duration.py b/tests/test_ext_duration.py index c1f2ca96e..71b7a8f9c 100644 --- a/tests/test_ext_duration.py +++ b/tests/test_ext_duration.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.duration extension. +"""Test sphinx.ext.duration extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_githubpages.py b/tests/test_ext_githubpages.py index 3b63a2c2e..d3d703fb1 100644 --- a/tests/test_ext_githubpages.py +++ b/tests/test_ext_githubpages.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.githubpages extension. +"""Test sphinx.ext.githubpages extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py index f916fb1b9..f6812a9ce 100644 --- a/tests/test_ext_graphviz.py +++ b/tests/test_ext_graphviz.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.graphviz extension. +"""Test sphinx.ext.graphviz extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_ifconfig.py b/tests/test_ext_ifconfig.py index 4bc7f519f..e225ff76a 100644 --- a/tests/test_ext_ifconfig.py +++ b/tests/test_ext_ifconfig.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.ifconfig extension. +"""Test sphinx.ext.ifconfig extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_imgconverter.py b/tests/test_ext_imgconverter.py index 478bf8df4..5e5f00b15 100644 --- a/tests/test_ext_imgconverter.py +++ b/tests/test_ext_imgconverter.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.imgconverter extension. +"""Test sphinx.ext.imgconverter extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py index ad594c2eb..2d1b61e62 100644 --- a/tests/test_ext_inheritance_diagram.py +++ b/tests/test_ext_inheritance_diagram.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.inheritance_diagram extension. +"""Test sphinx.ext.inheritance_diagram extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py index 21ce6f952..f363c6c96 100644 --- a/tests/test_ext_intersphinx.py +++ b/tests/test_ext_intersphinx.py @@ -1,5 +1,4 @@ -""" - Test the intersphinx extension. +"""Test the intersphinx extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index 20fc75279..18ad0968e 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -1,5 +1,4 @@ -""" - Test math extensions. +"""Test math extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_napoleon.py b/tests/test_ext_napoleon.py index 75894f9c0..8ce4b542d 100644 --- a/tests/test_ext_napoleon.py +++ b/tests/test_ext_napoleon.py @@ -1,5 +1,4 @@ -""" - Tests for :mod:`sphinx.ext.napoleon.__init__` module. +"""Tests for :mod:`sphinx.ext.napoleon.__init__` module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index eb2252fb9..271e08333 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -1,5 +1,4 @@ -""" - Tests for :mod:`sphinx.ext.napoleon.docstring` module. +"""Tests for :mod:`sphinx.ext.napoleon.docstring` module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_napoleon_iterators.py b/tests/test_ext_napoleon_iterators.py index 0ccc94a06..74618f740 100644 --- a/tests/test_ext_napoleon_iterators.py +++ b/tests/test_ext_napoleon_iterators.py @@ -1,5 +1,4 @@ -""" - Tests for :mod:`sphinx.ext.napoleon.iterators` module. +"""Tests for :mod:`sphinx.ext.napoleon.iterators` module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_todo.py b/tests/test_ext_todo.py index 010b66034..93c0cb7ca 100644 --- a/tests/test_ext_todo.py +++ b/tests/test_ext_todo.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.todo extension. +"""Test sphinx.ext.todo extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py index 5b416d14d..688fa7607 100644 --- a/tests/test_ext_viewcode.py +++ b/tests/test_ext_viewcode.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.viewcode extension. +"""Test sphinx.ext.viewcode extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_extension.py b/tests/test_extension.py index 0955dc382..ca35e0ae5 100644 --- a/tests/test_extension.py +++ b/tests/test_extension.py @@ -1,5 +1,4 @@ -""" - Test sphinx.extension module. +"""Test sphinx.extension module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index 4238882df..0b0687196 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -1,5 +1,4 @@ -""" - Test the Pygments highlighting bridge. +"""Test the Pygments highlighting bridge. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_intl.py b/tests/test_intl.py index c89df5732..8fccb33b6 100644 --- a/tests/test_intl.py +++ b/tests/test_intl.py @@ -1,5 +1,4 @@ -""" - Test message patching for internationalization purposes. Runs the text +"""Test message patching for internationalization purposes. Runs the text builder in the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_locale.py b/tests/test_locale.py index aadac7b8f..f88e17b78 100644 --- a/tests/test_locale.py +++ b/tests/test_locale.py @@ -1,5 +1,4 @@ -""" - Test locale. +"""Test locale. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_markup.py b/tests/test_markup.py index a2ffbf17e..c7c955048 100644 --- a/tests/test_markup.py +++ b/tests/test_markup.py @@ -1,5 +1,4 @@ -""" - Test various Sphinx-specific markup extensions. +"""Test various Sphinx-specific markup extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_metadata.py b/tests/test_metadata.py index 86a9896bf..0092158aa 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1,5 +1,4 @@ -""" - Test our handling of metadata in files with bibliographic metadata. +"""Test our handling of metadata in files with bibliographic metadata. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_parser.py b/tests/test_parser.py index 8098c74af..3ff10eff8 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -1,5 +1,4 @@ -""" - Tests parsers module. +"""Tests parsers module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_project.py b/tests/test_project.py index 6996e8202..cd48c33a1 100644 --- a/tests/test_project.py +++ b/tests/test_project.py @@ -1,5 +1,4 @@ -""" - Tests project module. +"""Tests project module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_pycode.py b/tests/test_pycode.py index 267395a21..1de3f615d 100644 --- a/tests/test_pycode.py +++ b/tests/test_pycode.py @@ -1,5 +1,4 @@ -""" - Test pycode. +"""Test pycode. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_pycode_ast.py b/tests/test_pycode_ast.py index d1150e3b0..6cf8b77ee 100644 --- a/tests/test_pycode_ast.py +++ b/tests/test_pycode_ast.py @@ -1,5 +1,4 @@ -""" - Test pycode.ast +"""Test pycode.ast :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_pycode_parser.py b/tests/test_pycode_parser.py index 264636907..c1456a0a6 100644 --- a/tests/test_pycode_parser.py +++ b/tests/test_pycode_parser.py @@ -1,5 +1,4 @@ -""" - Test pycode.parser. +"""Test pycode.parser. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py index 940897b5b..c4eaed0ae 100644 --- a/tests/test_quickstart.py +++ b/tests/test_quickstart.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.quickstart module. +"""Test the sphinx.quickstart module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_roles.py b/tests/test_roles.py index b531c7d8b..5cf78f18d 100644 --- a/tests/test_roles.py +++ b/tests/test_roles.py @@ -1,5 +1,4 @@ -""" - Test sphinx.roles +"""Test sphinx.roles :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_search.py b/tests/test_search.py index e2cac35c1..f58164141 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -1,5 +1,4 @@ -""" - Test the search index builder. +"""Test the search index builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py index 41571a2c1..d1bbb5823 100644 --- a/tests/test_setup_command.py +++ b/tests/test_setup_command.py @@ -1,5 +1,4 @@ -""" - Test setup_command for distutils. +"""Test setup_command for distutils. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_smartquotes.py b/tests/test_smartquotes.py index 78f0faae8..c7920f26a 100644 --- a/tests/test_smartquotes.py +++ b/tests/test_smartquotes.py @@ -1,5 +1,4 @@ -""" - Test smart quotes. +"""Test smart quotes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_templating.py b/tests/test_templating.py index 1def07050..f519b5e8d 100644 --- a/tests/test_templating.py +++ b/tests/test_templating.py @@ -1,5 +1,4 @@ -""" - Test templating. +"""Test templating. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_theming.py b/tests/test_theming.py index b760671bc..4178114c9 100644 --- a/tests/test_theming.py +++ b/tests/test_theming.py @@ -1,5 +1,4 @@ -""" - Test the Theme class. +"""Test the Theme class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_toctree.py b/tests/test_toctree.py index 62f561d87..8e422041b 100644 --- a/tests/test_toctree.py +++ b/tests/test_toctree.py @@ -1,5 +1,4 @@ -""" - Test the HTML builder and check output against XPath. +"""Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_transforms_post_transforms.py b/tests/test_transforms_post_transforms.py index c3e7613fe..e7dba7619 100644 --- a/tests/test_transforms_post_transforms.py +++ b/tests/test_transforms_post_transforms.py @@ -1,5 +1,4 @@ -""" - Tests the post_transforms +"""Tests the post_transforms :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util.py b/tests/test_util.py index ade5d36f9..76ae43bcd 100644 --- a/tests/test_util.py +++ b/tests/test_util.py @@ -1,5 +1,4 @@ -""" - Tests util functions. +"""Tests util functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_docstrings.py b/tests/test_util_docstrings.py index fe8727e66..a8ac6912e 100644 --- a/tests/test_util_docstrings.py +++ b/tests/test_util_docstrings.py @@ -1,5 +1,4 @@ -""" - Test sphinx.util.docstrings. +"""Test sphinx.util.docstrings. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_docutils.py b/tests/test_util_docutils.py index 2ee8953a7..3af3861f9 100644 --- a/tests/test_util_docutils.py +++ b/tests/test_util_docutils.py @@ -1,5 +1,4 @@ -""" - Tests util.utils functions. +"""Tests util.utils functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_fileutil.py b/tests/test_util_fileutil.py index 90264a945..d1d4297c0 100644 --- a/tests/test_util_fileutil.py +++ b/tests/test_util_fileutil.py @@ -1,5 +1,4 @@ -""" - Tests sphinx.util.fileutil functions. +"""Tests sphinx.util.fileutil functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_i18n.py b/tests/test_util_i18n.py index fd67446ae..49118daae 100644 --- a/tests/test_util_i18n.py +++ b/tests/test_util_i18n.py @@ -1,5 +1,4 @@ -""" - Test i18n util. +"""Test i18n util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_images.py b/tests/test_util_images.py index 5dbe2a8ed..7b21af430 100644 --- a/tests/test_util_images.py +++ b/tests/test_util_images.py @@ -1,5 +1,4 @@ -""" - Test images util. +"""Test images util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 18abbe86c..02e7244cd 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -1,5 +1,4 @@ -""" - Tests util.inspect functions. +"""Tests util.inspect functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_inventory.py b/tests/test_util_inventory.py index d621fd17d..1aae84589 100644 --- a/tests/test_util_inventory.py +++ b/tests/test_util_inventory.py @@ -1,5 +1,4 @@ -""" - Test inventory util functions. +"""Test inventory util functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py index bb3d3260a..42bfd137b 100644 --- a/tests/test_util_logging.py +++ b/tests/test_util_logging.py @@ -1,5 +1,4 @@ -""" - Test logging util. +"""Test logging util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_matching.py b/tests/test_util_matching.py index 91d284b23..4a7fd28dc 100644 --- a/tests/test_util_matching.py +++ b/tests/test_util_matching.py @@ -1,5 +1,4 @@ -""" - Tests sphinx.util.matching functions. +"""Tests sphinx.util.matching functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_nodes.py b/tests/test_util_nodes.py index a682dc295..71e2d637a 100644 --- a/tests/test_util_nodes.py +++ b/tests/test_util_nodes.py @@ -1,5 +1,4 @@ -""" - Tests uti.nodes functions. +"""Tests uti.nodes functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_rst.py b/tests/test_util_rst.py index 4f76f584a..f80f7cdef 100644 --- a/tests/test_util_rst.py +++ b/tests/test_util_rst.py @@ -1,5 +1,4 @@ -""" - Tests sphinx.util.rst functions. +"""Tests sphinx.util.rst functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_template.py b/tests/test_util_template.py index b752a4c34..5380716aa 100644 --- a/tests/test_util_template.py +++ b/tests/test_util_template.py @@ -1,5 +1,4 @@ -""" - Tests sphinx.util.template functions. +"""Tests sphinx.util.template functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_typing.py b/tests/test_util_typing.py index ca3611a44..470524e23 100644 --- a/tests/test_util_typing.py +++ b/tests/test_util_typing.py @@ -1,5 +1,4 @@ -""" - Tests util.typing functions. +"""Tests util.typing functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_versioning.py b/tests/test_versioning.py index f615eb2cc..af00d56b1 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -1,5 +1,4 @@ -""" - Test the versioning implementation. +"""Test the versioning implementation. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_writer_latex.py b/tests/test_writer_latex.py index 31d27d591..0ab8511da 100644 --- a/tests/test_writer_latex.py +++ b/tests/test_writer_latex.py @@ -1,5 +1,4 @@ -""" - Test the LaTeX writer +"""Test the LaTeX writer :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/utils/checks.py b/utils/checks.py index 6798fde01..f69242614 100644 --- a/utils/checks.py +++ b/utils/checks.py @@ -1,5 +1,4 @@ -""" - Custom, Sphinx-only flake8 plugins. +"""Custom, Sphinx-only flake8 plugins. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/utils/doclinter.py b/utils/doclinter.py index ed61b9c97..93351becb 100644 --- a/utils/doclinter.py +++ b/utils/doclinter.py @@ -1,5 +1,4 @@ -""" - A linter for Sphinx docs +"""A linter for Sphinx docs :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/utils/jssplitter_generator.py b/utils/jssplitter_generator.py index 0e95cfe56..c62ceb37f 100644 --- a/utils/jssplitter_generator.py +++ b/utils/jssplitter_generator.py @@ -112,8 +112,7 @@ console.log(' ... ok\\n') ''' % js_src python_src = '''\ -""" - Provides Python compatible word splitter to JavaScript +"""Provides Python compatible word splitter to JavaScript DO NOT EDIT. This is generated by utils/jssplitter_generator.py From 5694e0ce60316b9cb9709d147e1a699ea9bde6da Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 00:23:29 +0000 Subject: [PATCH 3/9] Fix module docstring indentation --- sphinx/__init__.py | 4 +- sphinx/__main__.py | 4 +- sphinx/addnodes.py | 4 +- sphinx/application.py | 6 +- sphinx/builders/__init__.py | 4 +- sphinx/builders/_epub_base.py | 4 +- sphinx/builders/changes.py | 4 +- sphinx/builders/dirhtml.py | 4 +- sphinx/builders/dummy.py | 4 +- sphinx/builders/epub3.py | 6 +- sphinx/builders/gettext.py | 4 +- sphinx/builders/html/__init__.py | 4 +- sphinx/builders/html/transforms.py | 4 +- sphinx/builders/latex/__init__.py | 4 +- sphinx/builders/latex/constants.py | 4 +- sphinx/builders/latex/nodes.py | 4 +- sphinx/builders/latex/theming.py | 4 +- sphinx/builders/latex/transforms.py | 4 +- sphinx/builders/latex/util.py | 4 +- sphinx/builders/linkcheck.py | 4 +- sphinx/builders/manpage.py | 4 +- sphinx/builders/singlehtml.py | 4 +- sphinx/builders/texinfo.py | 4 +- sphinx/builders/text.py | 4 +- sphinx/builders/xml.py | 4 +- sphinx/cmd/__init__.py | 4 +- sphinx/cmd/build.py | 4 +- sphinx/cmd/make_mode.py | 12 ++-- sphinx/cmd/quickstart.py | 4 +- sphinx/config.py | 4 +- sphinx/deprecation.py | 4 +- sphinx/directives/__init__.py | 4 +- sphinx/directives/code.py | 4 +- sphinx/directives/other.py | 4 +- sphinx/directives/patches.py | 4 +- sphinx/domains/__init__.py | 6 +- sphinx/domains/c.py | 4 +- sphinx/domains/changeset.py | 4 +- sphinx/domains/citation.py | 4 +- sphinx/domains/cpp.py | 4 +- sphinx/domains/index.py | 4 +- sphinx/domains/javascript.py | 4 +- sphinx/domains/math.py | 4 +- sphinx/domains/python.py | 4 +- sphinx/domains/rst.py | 4 +- sphinx/domains/std.py | 4 +- sphinx/environment/__init__.py | 4 +- sphinx/environment/adapters/__init__.py | 4 +- sphinx/environment/adapters/asset.py | 4 +- sphinx/environment/adapters/indexentries.py | 4 +- sphinx/environment/adapters/toctree.py | 4 +- sphinx/environment/collectors/__init__.py | 4 +- sphinx/environment/collectors/asset.py | 4 +- sphinx/environment/collectors/dependencies.py | 4 +- sphinx/environment/collectors/metadata.py | 4 +- sphinx/environment/collectors/title.py | 4 +- sphinx/environment/collectors/toctree.py | 4 +- sphinx/errors.py | 6 +- sphinx/events.py | 6 +- sphinx/ext/__init__.py | 4 +- sphinx/ext/apidoc.py | 14 ++-- sphinx/ext/autodoc/__init__.py | 8 +-- sphinx/ext/autodoc/deprecated.py | 4 +- sphinx/ext/autodoc/directive.py | 4 +- sphinx/ext/autodoc/importer.py | 4 +- sphinx/ext/autodoc/mock.py | 4 +- sphinx/ext/autodoc/preserve_defaults.py | 6 +- sphinx/ext/autodoc/type_comment.py | 4 +- sphinx/ext/autodoc/typehints.py | 4 +- sphinx/ext/autosectionlabel.py | 4 +- sphinx/ext/autosummary/__init__.py | 64 +++++++++---------- sphinx/ext/autosummary/generate.py | 16 ++--- sphinx/ext/coverage.py | 6 +- sphinx/ext/doctest.py | 6 +- sphinx/ext/duration.py | 4 +- sphinx/ext/extlinks.py | 26 ++++---- sphinx/ext/githubpages.py | 4 +- sphinx/ext/graphviz.py | 6 +- sphinx/ext/ifconfig.py | 18 +++--- sphinx/ext/imgconverter.py | 4 +- sphinx/ext/imgmath.py | 4 +- sphinx/ext/inheritance_diagram.py | 42 ++++++------ sphinx/ext/intersphinx.py | 26 ++++---- sphinx/ext/linkcode.py | 4 +- sphinx/ext/mathjax.py | 8 +-- sphinx/ext/napoleon/__init__.py | 4 +- sphinx/ext/napoleon/docstring.py | 6 +- sphinx/ext/napoleon/iterators.py | 6 +- sphinx/ext/todo.py | 10 +-- sphinx/ext/viewcode.py | 4 +- sphinx/extension.py | 4 +- sphinx/highlighting.py | 4 +- sphinx/io.py | 4 +- sphinx/jinja2glue.py | 4 +- sphinx/locale/__init__.py | 4 +- sphinx/parsers.py | 4 +- sphinx/project.py | 4 +- sphinx/pycode/__init__.py | 4 +- sphinx/pycode/ast.py | 4 +- sphinx/pycode/parser.py | 4 +- sphinx/pygments_styles.py | 4 +- sphinx/registry.py | 4 +- sphinx/roles.py | 4 +- sphinx/search/__init__.py | 4 +- sphinx/search/da.py | 4 +- sphinx/search/de.py | 4 +- sphinx/search/en.py | 4 +- sphinx/search/es.py | 4 +- sphinx/search/fi.py | 4 +- sphinx/search/fr.py | 4 +- sphinx/search/hu.py | 4 +- sphinx/search/it.py | 4 +- sphinx/search/ja.py | 4 +- sphinx/search/jssplitter.py | 6 +- sphinx/search/nl.py | 4 +- sphinx/search/no.py | 4 +- sphinx/search/pt.py | 4 +- sphinx/search/ro.py | 4 +- sphinx/search/ru.py | 4 +- sphinx/search/sv.py | 4 +- sphinx/search/tr.py | 4 +- sphinx/search/zh.py | 4 +- sphinx/setup_command.py | 10 +-- sphinx/testing/__init__.py | 10 +-- sphinx/testing/comparer.py | 4 +- sphinx/testing/fixtures.py | 4 +- sphinx/testing/path.py | 4 +- sphinx/testing/restructuredtext.py | 4 +- sphinx/testing/util.py | 4 +- sphinx/theming.py | 4 +- sphinx/transforms/__init__.py | 4 +- sphinx/transforms/compact_bullet_list.py | 4 +- sphinx/transforms/i18n.py | 4 +- sphinx/transforms/post_transforms/__init__.py | 4 +- sphinx/transforms/post_transforms/code.py | 4 +- sphinx/transforms/post_transforms/images.py | 4 +- sphinx/transforms/references.py | 4 +- sphinx/util/__init__.py | 4 +- sphinx/util/build_phase.py | 4 +- sphinx/util/cfamily.py | 4 +- sphinx/util/compat.py | 4 +- sphinx/util/console.py | 4 +- sphinx/util/docfields.py | 6 +- sphinx/util/docstrings.py | 4 +- sphinx/util/docutils.py | 4 +- sphinx/util/fileutil.py | 4 +- sphinx/util/i18n.py | 4 +- sphinx/util/images.py | 4 +- sphinx/util/inspect.py | 4 +- sphinx/util/inventory.py | 4 +- sphinx/util/jsdump.py | 6 +- sphinx/util/logging.py | 4 +- sphinx/util/matching.py | 4 +- sphinx/util/math.py | 4 +- sphinx/util/nodes.py | 4 +- sphinx/util/osutil.py | 4 +- sphinx/util/parallel.py | 4 +- sphinx/util/png.py | 4 +- sphinx/util/pycompat.py | 4 +- sphinx/util/requests.py | 4 +- sphinx/util/rst.py | 4 +- sphinx/util/smartypants.py | 30 ++++----- sphinx/util/stemmer/__init__.py | 4 +- sphinx/util/stemmer/porter.py | 30 ++++----- sphinx/util/tags.py | 4 +- sphinx/util/template.py | 4 +- sphinx/util/texescape.py | 4 +- sphinx/util/typing.py | 4 +- sphinx/versioning.py | 6 +- sphinx/writers/__init__.py | 4 +- sphinx/writers/html.py | 4 +- sphinx/writers/html5.py | 4 +- sphinx/writers/latex.py | 8 +-- sphinx/writers/manpage.py | 4 +- sphinx/writers/texinfo.py | 4 +- sphinx/writers/text.py | 4 +- sphinx/writers/xml.py | 4 +- tests/conftest.py | 4 +- tests/test_api_translator.py | 4 +- tests/test_application.py | 4 +- tests/test_build.py | 4 +- tests/test_build_changes.py | 4 +- tests/test_build_dirhtml.py | 4 +- tests/test_build_epub.py | 4 +- tests/test_build_gettext.py | 4 +- tests/test_build_html.py | 4 +- tests/test_build_latex.py | 4 +- tests/test_build_linkcheck.py | 4 +- tests/test_build_manpage.py | 4 +- tests/test_build_texinfo.py | 4 +- tests/test_build_text.py | 4 +- tests/test_builder.py | 4 +- tests/test_catalogs.py | 4 +- tests/test_config.py | 6 +- tests/test_correct_year.py | 4 +- tests/test_directive_code.py | 4 +- tests/test_directive_only.py | 4 +- tests/test_directive_other.py | 4 +- tests/test_directive_patch.py | 4 +- tests/test_docutilsconf.py | 4 +- tests/test_domain_c.py | 4 +- tests/test_domain_cpp.py | 4 +- tests/test_domain_js.py | 4 +- tests/test_domain_py.py | 4 +- tests/test_domain_rst.py | 4 +- tests/test_domain_std.py | 4 +- tests/test_environment.py | 4 +- tests/test_environment_indexentries.py | 4 +- tests/test_environment_toctree.py | 4 +- tests/test_events.py | 4 +- tests/test_ext_apidoc.py | 4 +- tests/test_ext_autodoc.py | 6 +- tests/test_ext_autodoc_autoattribute.py | 6 +- tests/test_ext_autodoc_autoclass.py | 6 +- tests/test_ext_autodoc_autodata.py | 6 +- tests/test_ext_autodoc_autofunction.py | 6 +- tests/test_ext_autodoc_automodule.py | 6 +- tests/test_ext_autodoc_autoproperty.py | 6 +- tests/test_ext_autodoc_configs.py | 4 +- tests/test_ext_autodoc_events.py | 4 +- tests/test_ext_autodoc_mock.py | 4 +- tests/test_ext_autodoc_preserve_defaults.py | 4 +- tests/test_ext_autodoc_private_members.py | 4 +- tests/test_ext_autosectionlabel.py | 4 +- tests/test_ext_autosummary.py | 4 +- tests/test_ext_coverage.py | 4 +- tests/test_ext_doctest.py | 4 +- tests/test_ext_duration.py | 4 +- tests/test_ext_githubpages.py | 4 +- tests/test_ext_graphviz.py | 4 +- tests/test_ext_ifconfig.py | 4 +- tests/test_ext_imgconverter.py | 4 +- tests/test_ext_inheritance_diagram.py | 4 +- tests/test_ext_intersphinx.py | 4 +- tests/test_ext_math.py | 4 +- tests/test_ext_napoleon.py | 4 +- tests/test_ext_napoleon_docstring.py | 4 +- tests/test_ext_napoleon_iterators.py | 4 +- tests/test_ext_todo.py | 4 +- tests/test_ext_viewcode.py | 4 +- tests/test_extension.py | 4 +- tests/test_highlighting.py | 4 +- tests/test_intl.py | 6 +- tests/test_locale.py | 4 +- tests/test_markup.py | 4 +- tests/test_metadata.py | 4 +- tests/test_parser.py | 4 +- tests/test_project.py | 4 +- tests/test_pycode.py | 4 +- tests/test_pycode_ast.py | 4 +- tests/test_pycode_parser.py | 4 +- tests/test_quickstart.py | 4 +- tests/test_roles.py | 4 +- tests/test_search.py | 4 +- tests/test_setup_command.py | 4 +- tests/test_smartquotes.py | 4 +- tests/test_templating.py | 4 +- tests/test_theming.py | 4 +- tests/test_toctree.py | 4 +- tests/test_transforms_post_transforms.py | 4 +- tests/test_transforms_post_transforms_code.py | 4 +- tests/test_util.py | 4 +- tests/test_util_docstrings.py | 4 +- tests/test_util_docutils.py | 4 +- tests/test_util_fileutil.py | 4 +- tests/test_util_i18n.py | 4 +- tests/test_util_images.py | 4 +- tests/test_util_inspect.py | 4 +- tests/test_util_inventory.py | 4 +- tests/test_util_logging.py | 4 +- tests/test_util_matching.py | 4 +- tests/test_util_nodes.py | 4 +- tests/test_util_rst.py | 4 +- tests/test_util_template.py | 4 +- tests/test_util_typing.py | 4 +- tests/test_versioning.py | 4 +- tests/test_writer_latex.py | 4 +- utils/checks.py | 4 +- utils/doclinter.py | 4 +- utils/jssplitter_generator.py | 6 +- 280 files changed, 719 insertions(+), 719 deletions(-) diff --git a/sphinx/__init__.py b/sphinx/__init__.py index 656f0bf39..d8612c478 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -1,7 +1,7 @@ """The Sphinx documentation toolchain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ # Keep this file executable as-is in Python 3! diff --git a/sphinx/__main__.py b/sphinx/__main__.py index 8897f3231..adf352d83 100644 --- a/sphinx/__main__.py +++ b/sphinx/__main__.py @@ -1,7 +1,7 @@ """The Sphinx documentation toolchain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index d2af6aa32..d089fd5e4 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -1,7 +1,7 @@ """Additional docutils nodes. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, List, Sequence diff --git a/sphinx/application.py b/sphinx/application.py index d060d3e35..e6a743bd5 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -1,9 +1,9 @@ """Sphinx application class and extensibility interface. - Gracefully adapted from the TextPress system by Armin. +Gracefully adapted from the TextPress system by Armin. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index e1f0ad4ec..f22524e1b 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -1,7 +1,7 @@ """Builder superclass for all builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pickle diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index 099be31b4..ab8a8f42b 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -1,7 +1,7 @@ """Base class of epub2/epub3 builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import html diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index 37b1afb1a..0351d0283 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -1,7 +1,7 @@ """Changelog builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import html diff --git a/sphinx/builders/dirhtml.py b/sphinx/builders/dirhtml.py index 9ffe634fe..e423d7f25 100644 --- a/sphinx/builders/dirhtml.py +++ b/sphinx/builders/dirhtml.py @@ -1,7 +1,7 @@ """Directory HTML builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/builders/dummy.py b/sphinx/builders/dummy.py index b1d5414df..cb9b51902 100644 --- a/sphinx/builders/dummy.py +++ b/sphinx/builders/dummy.py @@ -1,7 +1,7 @@ """Do syntax checks, but no writing. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Set diff --git a/sphinx/builders/epub3.py b/sphinx/builders/epub3.py index c7a9cb164..b413dce07 100644 --- a/sphinx/builders/epub3.py +++ b/sphinx/builders/epub3.py @@ -1,8 +1,8 @@ """Build epub3 files. - Originally derived from epub.py. +Originally derived from epub.py. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import html diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index 16d49f25d..20b61cdab 100644 --- a/sphinx/builders/gettext.py +++ b/sphinx/builders/gettext.py @@ -1,7 +1,7 @@ """The MessageCatalogBuilder class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from codecs import open diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py index 56008e474..13ef56956 100644 --- a/sphinx/builders/html/__init__.py +++ b/sphinx/builders/html/__init__.py @@ -1,7 +1,7 @@ """Several HTML builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import html diff --git a/sphinx/builders/html/transforms.py b/sphinx/builders/html/transforms.py index f8671dcec..b3670602d 100644 --- a/sphinx/builders/html/transforms.py +++ b/sphinx/builders/html/transforms.py @@ -1,7 +1,7 @@ """Transforms for HTML builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index ba71eba64..e8a50bd3d 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -1,7 +1,7 @@ """LaTeX builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py index ace27d6a7..a32778e46 100644 --- a/sphinx/builders/latex/constants.py +++ b/sphinx/builders/latex/constants.py @@ -1,7 +1,7 @@ """consntants for LaTeX builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict diff --git a/sphinx/builders/latex/nodes.py b/sphinx/builders/latex/nodes.py index 51fed2a9b..9432cfff9 100644 --- a/sphinx/builders/latex/nodes.py +++ b/sphinx/builders/latex/nodes.py @@ -1,7 +1,7 @@ """Additional nodes for LaTeX writer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from docutils import nodes diff --git a/sphinx/builders/latex/theming.py b/sphinx/builders/latex/theming.py index 434688841..3d0fa3b89 100644 --- a/sphinx/builders/latex/theming.py +++ b/sphinx/builders/latex/theming.py @@ -1,7 +1,7 @@ """Theming support for LaTeX builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import configparser diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py index 0dbaed100..f4ecf98b8 100644 --- a/sphinx/builders/latex/transforms.py +++ b/sphinx/builders/latex/transforms.py @@ -1,7 +1,7 @@ """Transforms for LaTeX builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, Set, Tuple, cast diff --git a/sphinx/builders/latex/util.py b/sphinx/builders/latex/util.py index 34fff7fcc..08f6b0fab 100644 --- a/sphinx/builders/latex/util.py +++ b/sphinx/builders/latex/util.py @@ -1,7 +1,7 @@ """Utilities for LaTeX builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Optional diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index 036b26836..23712122e 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -1,7 +1,7 @@ """The CheckExternalLinksBuilder class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import json diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index 76772d873..cbd24ae05 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -1,7 +1,7 @@ """Manual pages builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py index 0d65a0bcd..f65deab3f 100644 --- a/sphinx/builders/singlehtml.py +++ b/sphinx/builders/singlehtml.py @@ -1,7 +1,7 @@ """Single HTML builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index 431cec29e..a28939a93 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -1,7 +1,7 @@ """Texinfo builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index 4f400f577..b6dd4c343 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -1,7 +1,7 @@ """Plain-text Sphinx builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py index d3701f00a..a466fa917 100644 --- a/sphinx/builders/xml.py +++ b/sphinx/builders/xml.py @@ -1,7 +1,7 @@ """Docutils-native XML and pseudo-XML builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/cmd/__init__.py b/sphinx/cmd/__init__.py index 2ef622e26..7b22052c3 100644 --- a/sphinx/cmd/__init__.py +++ b/sphinx/cmd/__init__.py @@ -1,5 +1,5 @@ """Modules for command line executables. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index 16c9a6274..8605bfd7e 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -1,7 +1,7 @@ """Build documentation from a provided source. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import argparse diff --git a/sphinx/cmd/make_mode.py b/sphinx/cmd/make_mode.py index c8e694954..05945fb39 100644 --- a/sphinx/cmd/make_mode.py +++ b/sphinx/cmd/make_mode.py @@ -1,13 +1,13 @@ """sphinx-build -M command-line handling. - This replaces the old, platform-dependent and once-generated content - of Makefile / make.bat. +This replaces the old, platform-dependent and once-generated content +of Makefile / make.bat. - This is in its own module so that importing it is fast. It should not - import the main Sphinx modules (like sphinx.applications, sphinx.builders). +This is in its own module so that importing it is fast. It should not +import the main Sphinx modules (like sphinx.applications, sphinx.builders). - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index addb4c621..28b4d1618 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -1,7 +1,7 @@ """Quickly setup documentation source to work with Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import argparse diff --git a/sphinx/config.py b/sphinx/config.py index eabc79425..3b9eb61ba 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -1,7 +1,7 @@ """Build configuration file handling. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py index 7ee5b1773..f443b49d2 100644 --- a/sphinx/deprecation.py +++ b/sphinx/deprecation.py @@ -1,7 +1,7 @@ """Sphinx deprecation classes and utilities. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index 5bd57d9cd..58230841e 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -1,7 +1,7 @@ """Handlers for additional ReST directives. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/directives/code.py b/sphinx/directives/code.py index 971a42676..da5873711 100644 --- a/sphinx/directives/code.py +++ b/sphinx/directives/code.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index efd630262..b2249719c 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/directives/patches.py b/sphinx/directives/patches.py index 209b58893..5502028d0 100644 --- a/sphinx/directives/patches.py +++ b/sphinx/directives/patches.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py index 6942def51..9b3098e24 100644 --- a/sphinx/domains/__init__.py +++ b/sphinx/domains/__init__.py @@ -1,8 +1,8 @@ """Support for domains, which are groupings of description directives - and roles describing e.g. constructs of one programming language. +and roles describing e.g. constructs of one programming language. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import copy diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index 41742a624..e0ab20cb1 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -1,7 +1,7 @@ """The C language domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index 91cf7412f..6f9f9383d 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -1,7 +1,7 @@ """The changeset domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, cast diff --git a/sphinx/domains/citation.py b/sphinx/domains/citation.py index 897d5b46a..53d56b205 100644 --- a/sphinx/domains/citation.py +++ b/sphinx/domains/citation.py @@ -1,7 +1,7 @@ """The citation domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, cast diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 7d4b19db8..1918b3b6e 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1,7 +1,7 @@ """The C++ language domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/domains/index.py b/sphinx/domains/index.py index e5ca1fa11..a82d27a69 100644 --- a/sphinx/domains/index.py +++ b/sphinx/domains/index.py @@ -1,7 +1,7 @@ """The index domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Tuple diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 68303d8eb..40502456f 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -1,7 +1,7 @@ """The JavaScript domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Iterator, List, Optional, Tuple, cast diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py index ce7df96a1..0caecc858 100644 --- a/sphinx/domains/math.py +++ b/sphinx/domains/math.py @@ -1,7 +1,7 @@ """The math domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index 6cd7af93c..ea7964417 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -1,7 +1,7 @@ """The Python domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import builtins diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py index 549818d03..f7265e3c6 100644 --- a/sphinx/domains/rst.py +++ b/sphinx/domains/rst.py @@ -1,7 +1,7 @@ """The reStructuredText domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index b0a2e6bfc..2f84ec7ce 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -1,7 +1,7 @@ """The standard domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index df75296f6..64d4b92db 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -1,7 +1,7 @@ """Global creation environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/environment/adapters/__init__.py b/sphinx/environment/adapters/__init__.py index 3df72b665..886b0c35a 100644 --- a/sphinx/environment/adapters/__init__.py +++ b/sphinx/environment/adapters/__init__.py @@ -1,5 +1,5 @@ """Sphinx environment adapters - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ diff --git a/sphinx/environment/adapters/asset.py b/sphinx/environment/adapters/asset.py index a633d4e5d..4a952eca7 100644 --- a/sphinx/environment/adapters/asset.py +++ b/sphinx/environment/adapters/asset.py @@ -1,7 +1,7 @@ """Assets adapter for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from sphinx.environment import BuildEnvironment diff --git a/sphinx/environment/adapters/indexentries.py b/sphinx/environment/adapters/indexentries.py index 66689ab91..af7f7b4b1 100644 --- a/sphinx/environment/adapters/indexentries.py +++ b/sphinx/environment/adapters/indexentries.py @@ -1,7 +1,7 @@ """Index entries adapters for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index 6186f6f1d..ec766d491 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/sphinx/environment/adapters/toctree.py @@ -1,7 +1,7 @@ """Toctree adapter for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Iterable, List, Optional, cast diff --git a/sphinx/environment/collectors/__init__.py b/sphinx/environment/collectors/__init__.py index 6126a883f..db8c45c1b 100644 --- a/sphinx/environment/collectors/__init__.py +++ b/sphinx/environment/collectors/__init__.py @@ -1,7 +1,7 @@ """The data collector components for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Dict, List, Optional, Set diff --git a/sphinx/environment/collectors/asset.py b/sphinx/environment/collectors/asset.py index d98bfde53..0c296900d 100644 --- a/sphinx/environment/collectors/asset.py +++ b/sphinx/environment/collectors/asset.py @@ -1,7 +1,7 @@ """The image collector for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/environment/collectors/dependencies.py b/sphinx/environment/collectors/dependencies.py index 0512e6fd4..7014600b4 100644 --- a/sphinx/environment/collectors/dependencies.py +++ b/sphinx/environment/collectors/dependencies.py @@ -1,7 +1,7 @@ """The dependencies collector components for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/environment/collectors/metadata.py b/sphinx/environment/collectors/metadata.py index 67172b973..feb2e48dc 100644 --- a/sphinx/environment/collectors/metadata.py +++ b/sphinx/environment/collectors/metadata.py @@ -1,7 +1,7 @@ """The metadata collector components for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, Set, cast diff --git a/sphinx/environment/collectors/title.py b/sphinx/environment/collectors/title.py index df875d0e2..01385bda5 100644 --- a/sphinx/environment/collectors/title.py +++ b/sphinx/environment/collectors/title.py @@ -1,7 +1,7 @@ """The title collector components for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Set diff --git a/sphinx/environment/collectors/toctree.py b/sphinx/environment/collectors/toctree.py index c53ee6129..2df4267e3 100644 --- a/sphinx/environment/collectors/toctree.py +++ b/sphinx/environment/collectors/toctree.py @@ -1,7 +1,7 @@ """Toctree collector for sphinx.environment. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, Set, Tuple, Type, TypeVar, cast diff --git a/sphinx/errors.py b/sphinx/errors.py index e0aab4b05..30edd88a2 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,8 +1,8 @@ """Contains SphinxError and a few subclasses (in an extra module to avoid - circular import problems). +circular import problems). - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any diff --git a/sphinx/events.py b/sphinx/events.py index cb4d1f7d2..29d238964 100644 --- a/sphinx/events.py +++ b/sphinx/events.py @@ -1,9 +1,9 @@ """Sphinx core events. - Gracefully adapted from the TextPress system by Armin. +Gracefully adapted from the TextPress system by Armin. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from collections import defaultdict diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py index 4d293c049..e17fe0dbd 100644 --- a/sphinx/ext/__init__.py +++ b/sphinx/ext/__init__.py @@ -1,5 +1,5 @@ """Contains Sphinx features not activated by default. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py index c6ad9e984..6b93656f4 100644 --- a/sphinx/ext/apidoc.py +++ b/sphinx/ext/apidoc.py @@ -1,13 +1,13 @@ """Parses a directory tree looking for Python modules and packages and creates - ReST files appropriately to create code documentation with Sphinx. It also - creates a modules index (named modules.). +ReST files appropriately to create code documentation with Sphinx. It also +creates a modules index (named modules.). - This is derived from the "sphinx-autopackage" script, which is: - Copyright 2008 Société des arts technologiques (SAT), - https://sat.qc.ca/ +This is derived from the "sphinx-autopackage" script, which is: +Copyright 2008 Société des arts technologiques (SAT), +https://sat.qc.ca/ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import argparse diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 69dc1533a..a66c76b45 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1,9 +1,9 @@ """Automatically insert docstrings for functions, classes or whole modules into - the doctree, thus avoiding duplication between docstrings and documentation - for those who like elaborate docstrings. +the doctree, thus avoiding duplication between docstrings and documentation +for those who like elaborate docstrings. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/ext/autodoc/deprecated.py b/sphinx/ext/autodoc/deprecated.py index 740c87b80..d4399c2c9 100644 --- a/sphinx/ext/autodoc/deprecated.py +++ b/sphinx/ext/autodoc/deprecated.py @@ -1,7 +1,7 @@ """The deprecated Documenters for autodoc. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import warnings diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index a52f1c1a3..3eeeba94f 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import warnings diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py index 3f4810a14..df5dd1b66 100644 --- a/sphinx/ext/autodoc/importer.py +++ b/sphinx/ext/autodoc/importer.py @@ -1,7 +1,7 @@ """Importer utilities for autodoc - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import importlib diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py index aafb3f8c2..aa135e7b4 100644 --- a/sphinx/ext/autodoc/mock.py +++ b/sphinx/ext/autodoc/mock.py @@ -1,7 +1,7 @@ """mock for autodoc - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import contextlib diff --git a/sphinx/ext/autodoc/preserve_defaults.py b/sphinx/ext/autodoc/preserve_defaults.py index 8cde4d08f..fe71d088e 100644 --- a/sphinx/ext/autodoc/preserve_defaults.py +++ b/sphinx/ext/autodoc/preserve_defaults.py @@ -1,8 +1,8 @@ """Preserve the default argument values of function signatures in source code - and keep them not evaluated for readability. +and keep them not evaluated for readability. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import ast diff --git a/sphinx/ext/autodoc/type_comment.py b/sphinx/ext/autodoc/type_comment.py index f8cfa334a..192e3c0c3 100644 --- a/sphinx/ext/autodoc/type_comment.py +++ b/sphinx/ext/autodoc/type_comment.py @@ -1,7 +1,7 @@ """Update annotations info of living objects using type_comments. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from inspect import Parameter, Signature, getsource diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py index ccdbfb2b0..5532ade22 100644 --- a/sphinx/ext/autodoc/typehints.py +++ b/sphinx/ext/autodoc/typehints.py @@ -1,7 +1,7 @@ """Generating content for autodoc using typehints - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py index 5341248fc..cfd976437 100644 --- a/sphinx/ext/autosectionlabel.py +++ b/sphinx/ext/autosectionlabel.py @@ -1,7 +1,7 @@ """Allow reference sections by :ref: role using its title. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, cast diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index 1c7bce8cd..69d5a89a4 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -1,51 +1,51 @@ """Sphinx extension that adds an autosummary:: directive, which can be - used to generate function/method/attribute/etc. summary lists, similar - to those output eg. by Epydoc and other API doc generation tools. +used to generate function/method/attribute/etc. summary lists, similar +to those output eg. by Epydoc and other API doc generation tools. - An :autolink: role is also provided. +An :autolink: role is also provided. - autosummary directive - --------------------- +autosummary directive +--------------------- - The autosummary directive has the form:: +The autosummary directive has the form:: - .. autosummary:: - :nosignatures: - :toctree: generated/ + .. autosummary:: + :nosignatures: + :toctree: generated/ - module.function_1 - module.function_2 - ... + module.function_1 + module.function_2 + ... - and it generates an output table (containing signatures, optionally) +and it generates an output table (containing signatures, optionally) - ======================== ============================================= - module.function_1(args) Summary line from the docstring of function_1 - module.function_2(args) Summary line from the docstring - ... - ======================== ============================================= + ======================== ============================================= + module.function_1(args) Summary line from the docstring of function_1 + module.function_2(args) Summary line from the docstring + ... + ======================== ============================================= - If the :toctree: option is specified, files matching the function names - are inserted to the toctree with the given prefix: +If the :toctree: option is specified, files matching the function names +are inserted to the toctree with the given prefix: - generated/module.function_1 - generated/module.function_2 - ... + generated/module.function_1 + generated/module.function_2 + ... - Note: The file names contain the module:: or currentmodule:: prefixes. +Note: The file names contain the module:: or currentmodule:: prefixes. - .. seealso:: autosummary_generate.py +.. seealso:: autosummary_generate.py - autolink role - ------------- +autolink role +------------- - The autolink role functions as ``:obj:`` when the name referred can be - resolved to a Python object, and otherwise it becomes simple emphasis. - This can be used as the default role to make links 'smart'. +The autolink role functions as ``:obj:`` when the name referred can be +resolved to a Python object, and otherwise it becomes simple emphasis. +This can be used as the default role to make links 'smart'. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import inspect diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index 00f343da8..1912e3b08 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -1,16 +1,16 @@ """Usable as a library or script to generate automatic RST source files for - items referred to in autosummary:: directives. +items referred to in autosummary:: directives. - Each generated RST file contains a single auto*:: directive which - extracts the docstring of the referred item. +Each generated RST file contains a single auto*:: directive which +extracts the docstring of the referred item. - Example Makefile rule:: +Example Makefile rule:: - generate: - sphinx-autogen -o source/generated source/*.rst + generate: + sphinx-autogen -o source/generated source/*.rst - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import argparse diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index 6fd1b1fdc..a69bd6748 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -1,8 +1,8 @@ """Check Python modules and C API for coverage. Mostly written by Josip - Dzolonga for the Google Highly Open Participation contest. +Dzolonga for the Google Highly Open Participation contest. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import glob diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index 94082e78c..c1d3c5dd0 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -1,8 +1,8 @@ """Mimic doctest by automatically executing code snippets and checking - their results. +their results. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import doctest diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py index 8e624f24c..eed1362f4 100644 --- a/sphinx/ext/duration.py +++ b/sphinx/ext/duration.py @@ -1,7 +1,7 @@ """Measure durations of Sphinx processing. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from datetime import datetime, timedelta diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py index ba886b837..74f0ea5ed 100644 --- a/sphinx/ext/extlinks.py +++ b/sphinx/ext/extlinks.py @@ -1,24 +1,24 @@ """Extension to save typing and prevent hard-coding of base URLs in the reST - files. +files. - This adds a new config value called ``extlinks`` that is created like this:: +This adds a new config value called ``extlinks`` that is created like this:: - extlinks = {'exmpl': ('https://example.invalid/%s.html', caption), ...} + extlinks = {'exmpl': ('https://example.invalid/%s.html', caption), ...} - Now you can use e.g. :exmpl:`foo` in your documents. This will create a - link to ``https://example.invalid/foo.html``. The link caption depends on - the *caption* value given: +Now you can use e.g. :exmpl:`foo` in your documents. This will create a +link to ``https://example.invalid/foo.html``. The link caption depends on +the *caption* value given: - - If it is ``None``, the caption will be the full URL. - - If it is a string, it must contain ``%s`` exactly once. In this case the - caption will be *caption* with the role content substituted for ``%s``. +- If it is ``None``, the caption will be the full URL. +- If it is a string, it must contain ``%s`` exactly once. In this case the + caption will be *caption* with the role content substituted for ``%s``. - You can also give an explicit caption, e.g. :exmpl:`Foo `. +You can also give an explicit caption, e.g. :exmpl:`Foo `. - Both, the url string and the caption string must escape ``%`` as ``%%``. +Both, the url string and the caption string must escape ``%`` as ``%%``. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py index a59fde913..e30756124 100644 --- a/sphinx/ext/githubpages.py +++ b/sphinx/ext/githubpages.py @@ -1,7 +1,7 @@ """To publish HTML docs at GitHub Pages, create .nojekyll file. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index 6e2e8958d..189463d44 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -1,8 +1,8 @@ """Allow graphviz-formatted graphs to be included in Sphinx-generated - documents inline. +documents inline. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import posixpath diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index f46241409..244fa8187 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -1,18 +1,18 @@ """Provides the ``ifconfig`` directive that allows to write documentation - that is included depending on configuration variables. +that is included depending on configuration variables. - Usage:: +Usage:: - .. ifconfig:: releaselevel in ('alpha', 'beta', 'rc') + .. ifconfig:: releaselevel in ('alpha', 'beta', 'rc') - This stuff is only included in the built docs for unstable versions. + This stuff is only included in the built docs for unstable versions. - The argument for ``ifconfig`` is a plain Python expression, evaluated in the - namespace of the project configuration (that is, all variables from - ``conf.py`` are available.) +The argument for ``ifconfig`` is a plain Python expression, evaluated in the +namespace of the project configuration (that is, all variables from +``conf.py`` are available.) - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index e5582de4b..40e3c2c18 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -1,7 +1,7 @@ """Image converter extension for Sphinx - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import subprocess diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index 47ba9d927..b95f3c71d 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -1,7 +1,7 @@ """Render math in HTML via dvipng or dvisvgm. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import posixpath diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index 1afd6c5ab..802f91b76 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -1,34 +1,34 @@ r"""Defines a docutils directive for inserting inheritance diagrams. - Provide the directive with one or more classes or modules (separated - by whitespace). For modules, all of the classes in that module will - be used. +Provide the directive with one or more classes or modules (separated +by whitespace). For modules, all of the classes in that module will +be used. - Example:: +Example:: - Given the following classes: + Given the following classes: - class A: pass - class B(A): pass - class C(A): pass - class D(B, C): pass - class E(B): pass + class A: pass + class B(A): pass + class C(A): pass + class D(B, C): pass + class E(B): pass - .. inheritance-diagram: D E + .. inheritance-diagram: D E - Produces a graph like the following: + Produces a graph like the following: - A - / \ - B C - / \ / - E D + A + / \ + B C + / \ / + E D - The graph is inserted as a PNG+image map into HTML and a PDF in - LaTeX. +The graph is inserted as a PNG+image map into HTML and a PDF in +LaTeX. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import builtins diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index ad27fd4cf..57802442a 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -1,22 +1,22 @@ """Insert links to objects documented in remote Sphinx documentation. - This works as follows: +This works as follows: - * Each Sphinx HTML build creates a file named "objects.inv" that contains a - mapping from object names to URIs relative to the HTML set's root. +* Each Sphinx HTML build creates a file named "objects.inv" that contains a + mapping from object names to URIs relative to the HTML set's root. - * Projects using the Intersphinx extension can specify links to such mapping - files in the `intersphinx_mapping` config value. The mapping will then be - used to resolve otherwise missing references to objects into links to the - other documentation. +* Projects using the Intersphinx extension can specify links to such mapping + files in the `intersphinx_mapping` config value. The mapping will then be + used to resolve otherwise missing references to objects into links to the + other documentation. - * By default, the mapping file is assumed to be at the same location as the - rest of the documentation; however, the location of the mapping file can - also be specified individually, e.g. if the docs should be buildable - without Internet access. +* By default, the mapping file is assumed to be at the same location as the + rest of the documentation; however, the location of the mapping file can + also be specified individually, e.g. if the docs should be buildable + without Internet access. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import concurrent.futures diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index 2f6c73846..e6f3d24e4 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -1,7 +1,7 @@ """Add external links to module code in Python object descriptions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Set diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index d2c7affcb..a411cd558 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -1,9 +1,9 @@ """Allow `MathJax `_ to be used to display math in - Sphinx's HTML writer -- requires the MathJax JavaScript library on your - webserver/computer. +Sphinx's HTML writer -- requires the MathJax JavaScript library on your +webserver/computer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import json diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index cc1ec3638..7f939a559 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -1,7 +1,7 @@ """Support for NumPy and Google style docstrings. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index cd68deeff..52256f5e9 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -1,10 +1,10 @@ """ - Classes for docstring parsing and formatting. +Classes for docstring parsing and formatting. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import collections diff --git a/sphinx/ext/napoleon/iterators.py b/sphinx/ext/napoleon/iterators.py index b6e549f70..5a94fafd4 100644 --- a/sphinx/ext/napoleon/iterators.py +++ b/sphinx/ext/napoleon/iterators.py @@ -1,10 +1,10 @@ """ - A collection of helpful iterators. +A collection of helpful iterators. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import collections diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index 4e06aee5a..d4234c06b 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -1,10 +1,10 @@ """Allow todos to be inserted into your documentation. Inclusion of todos can - be switched of by a configuration variable. The todolist directive collects - all todos of your project and lists them along with a backlink to the - original location. +be switched of by a configuration variable. The todolist directive collects +all todos of your project and lists them along with a backlink to the +original location. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, Tuple, cast diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index fb6b3df10..2c2dc6a39 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -1,7 +1,7 @@ """Add links to module code in Python object descriptions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import posixpath diff --git a/sphinx/extension.py b/sphinx/extension.py index 584ce6add..0aeed6893 100644 --- a/sphinx/extension.py +++ b/sphinx/extension.py @@ -1,7 +1,7 @@ """Utilities for Sphinx extensions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 3580b3efb..a729f7997 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -1,7 +1,7 @@ """Highlight code blocks using Pygments. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from functools import partial diff --git a/sphinx/io.py b/sphinx/io.py index 63c04168e..5c0acb158 100644 --- a/sphinx/io.py +++ b/sphinx/io.py @@ -1,7 +1,7 @@ """Input/Output files - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import codecs from typing import TYPE_CHECKING, Any, List, Type diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index dbc5cab8b..e9a66105a 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -1,7 +1,7 @@ """Glue code for the jinja2 templating engine. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py index dabba8519..19c4c9d3a 100644 --- a/sphinx/locale/__init__.py +++ b/sphinx/locale/__init__.py @@ -1,7 +1,7 @@ """Locale utilities. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import gettext diff --git a/sphinx/parsers.py b/sphinx/parsers.py index ee1be5b10..b5aa03f7b 100644 --- a/sphinx/parsers.py +++ b/sphinx/parsers.py @@ -1,7 +1,7 @@ """A Base class for additional parsers. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import warnings diff --git a/sphinx/project.py b/sphinx/project.py index c8d7fc9dd..a0956d07b 100644 --- a/sphinx/project.py +++ b/sphinx/project.py @@ -1,7 +1,7 @@ """Utility function and classes for Sphinx projects. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index 0188e9bcb..6e7e5b751 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -1,7 +1,7 @@ """Utilities parsing and analyzing Python code. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py index 8c8f65d8b..a8ac68c42 100644 --- a/sphinx/pycode/ast.py +++ b/sphinx/pycode/ast.py @@ -1,7 +1,7 @@ """Helpers for AST (Abstract Syntax Tree). - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py index e47b229a1..4edab750a 100644 --- a/sphinx/pycode/parser.py +++ b/sphinx/pycode/parser.py @@ -1,7 +1,7 @@ """Utilities parsing and analyzing Python code. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import inspect import itertools diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py index ac3556194..73ee9d853 100644 --- a/sphinx/pygments_styles.py +++ b/sphinx/pygments_styles.py @@ -1,7 +1,7 @@ """Sphinx theme specific highlighting styles. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from pygments.style import Style diff --git a/sphinx/registry.py b/sphinx/registry.py index 59638c9a1..3979a02eb 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -1,7 +1,7 @@ """Sphinx component registry. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import traceback diff --git a/sphinx/roles.py b/sphinx/roles.py index 4c8fa2c8a..2327cfee5 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -1,7 +1,7 @@ """Handlers for additional ReST roles. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index 15fffd003..a4712f7d0 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -1,7 +1,7 @@ """Create a full-text search index for offline search. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import html import pickle diff --git a/sphinx/search/da.py b/sphinx/search/da.py index de20b45d4..5aebf7790 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -1,7 +1,7 @@ """Danish search language: includes the JS Danish stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/de.py b/sphinx/search/de.py index 05b3eeaee..3c02669bf 100644 --- a/sphinx/search/de.py +++ b/sphinx/search/de.py @@ -1,7 +1,7 @@ """German search language: includes the JS German stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/en.py b/sphinx/search/en.py index b6e4b31ed..49efabcd6 100644 --- a/sphinx/search/en.py +++ b/sphinx/search/en.py @@ -1,7 +1,7 @@ """English search language: includes the JS porter stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/es.py b/sphinx/search/es.py index 1bee7fbf7..f58c57f78 100644 --- a/sphinx/search/es.py +++ b/sphinx/search/es.py @@ -1,7 +1,7 @@ """Spanish search language: includes the JS Spanish stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py index a632ad647..e2685e672 100644 --- a/sphinx/search/fi.py +++ b/sphinx/search/fi.py @@ -1,7 +1,7 @@ """Finnish search language: includes the JS Finnish stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py index 19be35946..29bd71288 100644 --- a/sphinx/search/fr.py +++ b/sphinx/search/fr.py @@ -1,7 +1,7 @@ """French search language: includes the JS French stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py index 821aabcf9..99f461077 100644 --- a/sphinx/search/hu.py +++ b/sphinx/search/hu.py @@ -1,7 +1,7 @@ """Hungarian search language: includes the JS Hungarian stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/it.py b/sphinx/search/it.py index e751a17a1..c5781cd48 100644 --- a/sphinx/search/it.py +++ b/sphinx/search/it.py @@ -1,7 +1,7 @@ """Italian search language: includes the JS Italian stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index fab0595da..a9093dbd1 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -1,7 +1,7 @@ """Japanese search language: includes routine to split words. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ # Python Version of TinySegmenter diff --git a/sphinx/search/jssplitter.py b/sphinx/search/jssplitter.py index c4fe62737..82bb3951b 100644 --- a/sphinx/search/jssplitter.py +++ b/sphinx/search/jssplitter.py @@ -1,9 +1,9 @@ """Provides Python compatible word splitter to JavaScript - DO NOT EDIT. This is generated by utils/jssplitter_generator.py +DO NOT EDIT. This is generated by utils/jssplitter_generator.py - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ splitter_code = """ diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py index a7989b1ed..dff5740fa 100644 --- a/sphinx/search/nl.py +++ b/sphinx/search/nl.py @@ -1,7 +1,7 @@ """Dutch search language: includes the JS porter stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/no.py b/sphinx/search/no.py index c30352530..588d7b02d 100644 --- a/sphinx/search/no.py +++ b/sphinx/search/no.py @@ -1,7 +1,7 @@ """Norwegian search language: includes the JS Norwegian stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py index 994daebe7..d6bd43067 100644 --- a/sphinx/search/pt.py +++ b/sphinx/search/pt.py @@ -1,7 +1,7 @@ """Portuguese search language: includes the JS Portuguese stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/ro.py b/sphinx/search/ro.py index bbc5e9326..caa32236e 100644 --- a/sphinx/search/ro.py +++ b/sphinx/search/ro.py @@ -1,7 +1,7 @@ """Romanian search language: includes the JS Romanian stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict, Set diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index 53dd64e83..37234928a 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -1,7 +1,7 @@ """Russian search language: includes the JS Russian stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py index 0ee635416..f352b30dd 100644 --- a/sphinx/search/sv.py +++ b/sphinx/search/sv.py @@ -1,7 +1,7 @@ """Swedish search language: includes the JS Swedish stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/tr.py b/sphinx/search/tr.py index 75eca4731..d9b251308 100644 --- a/sphinx/search/tr.py +++ b/sphinx/search/tr.py @@ -1,7 +1,7 @@ """Turkish search language: includes the JS Turkish stemmer. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Dict, Set diff --git a/sphinx/search/zh.py b/sphinx/search/zh.py index 712fdf63b..3ebf2317a 100644 --- a/sphinx/search/zh.py +++ b/sphinx/search/zh.py @@ -1,7 +1,7 @@ """Chinese search language: includes routine to split words. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index 80914373a..40254cce5 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -1,10 +1,10 @@ """Setuptools/distutils commands to assist the building of sphinx - documentation. +documentation. - :author: Sebastian Wiesner - :contact: basti.wiesner@gmx.net - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:author: Sebastian Wiesner +:contact: basti.wiesner@gmx.net +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/testing/__init__.py b/sphinx/testing/__init__.py index 7798e69f7..e219d2c3f 100644 --- a/sphinx/testing/__init__.py +++ b/sphinx/testing/__init__.py @@ -1,10 +1,10 @@ """Sphinx test utilities - You can require sphinx.testing pytest fixtures in a test module or a conftest - file like this: +You can require sphinx.testing pytest fixtures in a test module or a conftest +file like this: - pytest_plugins = 'sphinx.testing.fixtures' + pytest_plugins = 'sphinx.testing.fixtures' - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ diff --git a/sphinx/testing/comparer.py b/sphinx/testing/comparer.py index e102a52c9..c6ee44bfb 100644 --- a/sphinx/testing/comparer.py +++ b/sphinx/testing/comparer.py @@ -1,7 +1,7 @@ """Sphinx test comparer for pytest - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import difflib import pathlib diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py index 15ecfb39c..c65986ba1 100644 --- a/sphinx/testing/fixtures.py +++ b/sphinx/testing/fixtures.py @@ -1,7 +1,7 @@ """Sphinx test fixtures for pytest - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import subprocess diff --git a/sphinx/testing/path.py b/sphinx/testing/path.py index 984e0a01c..021fb0425 100644 --- a/sphinx/testing/path.py +++ b/sphinx/testing/path.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import builtins diff --git a/sphinx/testing/restructuredtext.py b/sphinx/testing/restructuredtext.py index aa0ebb354..87b875a59 100644 --- a/sphinx/testing/restructuredtext.py +++ b/sphinx/testing/restructuredtext.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py index a1b4b8601..904fdd221 100644 --- a/sphinx/testing/util.py +++ b/sphinx/testing/util.py @@ -1,7 +1,7 @@ """Sphinx test suite utilities - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import functools import os diff --git a/sphinx/theming.py b/sphinx/theming.py index 1931424d8..d77f4ff9c 100644 --- a/sphinx/theming.py +++ b/sphinx/theming.py @@ -1,7 +1,7 @@ """Theming support for HTML builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import configparser diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py index 60d1c2436..f3cb13a70 100644 --- a/sphinx/transforms/__init__.py +++ b/sphinx/transforms/__init__.py @@ -1,7 +1,7 @@ """Docutils transforms used by Sphinx when reading documents. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py index 7bcdb515c..ebbd303d4 100644 --- a/sphinx/transforms/compact_bullet_list.py +++ b/sphinx/transforms/compact_bullet_list.py @@ -1,7 +1,7 @@ """Docutils transforms used by Sphinx when reading documents. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, cast diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py index 62e75fa24..cc6250bf7 100644 --- a/sphinx/transforms/i18n.py +++ b/sphinx/transforms/i18n.py @@ -1,7 +1,7 @@ """Docutils transforms used by Sphinx when reading documents. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py index 5595ad4b7..63d3a7b1c 100644 --- a/sphinx/transforms/post_transforms/__init__.py +++ b/sphinx/transforms/post_transforms/__init__.py @@ -1,7 +1,7 @@ """Docutils transforms used by Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index 3af3b21c7..68be138dc 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -1,7 +1,7 @@ """transforms for code-blocks. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py index d7149c0c2..24d25f5b9 100644 --- a/sphinx/transforms/post_transforms/images.py +++ b/sphinx/transforms/post_transforms/images.py @@ -1,7 +1,7 @@ """Docutils transforms used by Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py index ed7a0b472..9b13c46df 100644 --- a/sphinx/transforms/references.py +++ b/sphinx/transforms/references.py @@ -1,7 +1,7 @@ """Docutils transforms used by Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index d6454735d..517d79369 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -1,7 +1,7 @@ """Utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import functools diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py index 4f7bf1a75..ec30f7987 100644 --- a/sphinx/util/build_phase.py +++ b/sphinx/util/build_phase.py @@ -1,7 +1,7 @@ """Build phase of Sphinx application. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from enum import IntEnum diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py index 0772bee20..cfdcc7bec 100644 --- a/sphinx/util/cfamily.py +++ b/sphinx/util/cfamily.py @@ -1,7 +1,7 @@ """Utility functions common to the C and C++ domains. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 8d5eed46e..1432d117e 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -1,7 +1,7 @@ """modules for backward compatibility - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/util/console.py b/sphinx/util/console.py index b391d524b..d844f21ee 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -1,7 +1,7 @@ """Format colored console output. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index adabab9c8..81887126a 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -1,8 +1,8 @@ """"Doc fields" are reST field lists in object descriptions that will - be domain-specifically transformed to a more appealing presentation. +be domain-specifically transformed to a more appealing presentation. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, List, Tuple, Type, Union, cast diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index 57ae47e86..5112b7949 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,7 +1,7 @@ """Utilities for docstring processing. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index 64726fcee..bb6029376 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -1,7 +1,7 @@ """Utility functions for docutils. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py index e633f77bd..e023e3871 100644 --- a/sphinx/util/fileutil.py +++ b/sphinx/util/fileutil.py @@ -1,7 +1,7 @@ """File utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py index 5e5cbec8a..1ce5e562f 100644 --- a/sphinx/util/i18n.py +++ b/sphinx/util/i18n.py @@ -1,7 +1,7 @@ """Builder superclass for all builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/images.py b/sphinx/util/images.py index 05572ec29..838c61b64 100644 --- a/sphinx/util/images.py +++ b/sphinx/util/images.py @@ -1,7 +1,7 @@ """Image utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import base64 diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 2d6aac13b..aa5cb7bba 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -1,7 +1,7 @@ """Helpers for inspecting Python modules. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import builtins diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py index e8e5e480e..08025cc80 100644 --- a/sphinx/util/inventory.py +++ b/sphinx/util/inventory.py @@ -1,7 +1,7 @@ """Inventory utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os import re diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index 0cad261ce..ae0075a66 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -1,8 +1,8 @@ """This module implements a simple JavaScript serializer. - Uses the basestring encode function from simplejson by Bob Ippolito. +Uses the basestring encode function from simplejson by Bob Ippolito. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py index a0c09bb20..38d06021b 100644 --- a/sphinx/util/logging.py +++ b/sphinx/util/logging.py @@ -1,7 +1,7 @@ """Logging utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import logging diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index c84cd757f..14988a200 100644 --- a/sphinx/util/matching.py +++ b/sphinx/util/matching.py @@ -1,7 +1,7 @@ """Pattern-matching utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/math.py b/sphinx/util/math.py index 0addaa5a0..d16051502 100644 --- a/sphinx/util/math.py +++ b/sphinx/util/math.py @@ -1,7 +1,7 @@ """Utility functions for math. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from docutils import nodes diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index b19597041..71888db1b 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -1,7 +1,7 @@ """Docutils node-related utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index e0d736229..f3b78448e 100644 --- a/sphinx/util/osutil.py +++ b/sphinx/util/osutil.py @@ -1,7 +1,7 @@ """Operating system-related utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import contextlib diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index 5a63fb9e9..4c093bb6f 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -1,7 +1,7 @@ """Parallel building utilities. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/png.py b/sphinx/util/png.py index cb0f86eb9..20d13b0d8 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -1,7 +1,7 @@ """PNG image manipulation helpers. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import binascii diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index a8b105cc7..431d5bb20 100644 --- a/sphinx/util/pycompat.py +++ b/sphinx/util/pycompat.py @@ -1,7 +1,7 @@ """Stuff for Python version compatibility. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import warnings diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py index 8241bc60b..c625109fe 100644 --- a/sphinx/util/requests.py +++ b/sphinx/util/requests.py @@ -1,7 +1,7 @@ """Simple requests package loader - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index 8b0f05507..2b94b933a 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -1,7 +1,7 @@ """reST helper functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/smartypants.py b/sphinx/util/smartypants.py index 363a4c97b..c1d9c4492 100644 --- a/sphinx/util/smartypants.py +++ b/sphinx/util/smartypants.py @@ -1,23 +1,23 @@ """This is extracted (with minor adaptations for flake8 compliance) from - docutils’ docutils/utils/smartquotes.py as of revision 8097 (30 May 2017), - in order to backport for Sphinx usage with Docutils < 0.14 extra language - configurations and fixes. Replaces earlier smartypants version as used up - to Sphinx 1.5.6. +docutils’ docutils/utils/smartquotes.py as of revision 8097 (30 May 2017), +in order to backport for Sphinx usage with Docutils < 0.14 extra language +configurations and fixes. Replaces earlier smartypants version as used up +to Sphinx 1.5.6. - :copyright: © 2010 Günter Milde, - original `SmartyPants`_: © 2003 John Gruber - smartypants.py: © 2004, 2007 Chad Miller - :license: Released under the terms of the `2-Clause BSD license`_, in short: +:copyright: © 2010 Günter Milde, + original `SmartyPants`_: © 2003 John Gruber + smartypants.py: © 2004, 2007 Chad Miller +:license: Released under the terms of the `2-Clause BSD license`_, in short: - Copying and distribution of this file, with or without modification, - are permitted in any medium without royalty provided the copyright - notices and this notice are preserved. - This file is offered as-is, without any warranty. + Copying and distribution of this file, with or without modification, + are permitted in any medium without royalty provided the copyright + notices and this notice are preserved. + This file is offered as-is, without any warranty. - .. _SmartyPants: https://daringfireball.net/projects/smartypants/ - .. _2-Clause BSD license: https://spdx.org/licenses/BSD-2-Clause +.. _SmartyPants: https://daringfireball.net/projects/smartypants/ +.. _2-Clause BSD license: https://spdx.org/licenses/BSD-2-Clause - See the LICENSE file and the original docutils code for details. +See the LICENSE file and the original docutils code for details. """ diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py index d7576a94e..4f38d81b7 100644 --- a/sphinx/util/stemmer/__init__.py +++ b/sphinx/util/stemmer/__init__.py @@ -1,7 +1,7 @@ """Word stemming utilities for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from sphinx.util.stemmer.porter import PorterStemmer diff --git a/sphinx/util/stemmer/porter.py b/sphinx/util/stemmer/porter.py index 6068e76ab..46983cbac 100644 --- a/sphinx/util/stemmer/porter.py +++ b/sphinx/util/stemmer/porter.py @@ -1,26 +1,26 @@ """Porter Stemming Algorithm - This is the Porter stemming algorithm, ported to Python from the - version coded up in ANSI C by the author. It may be be regarded - as canonical, in that it follows the algorithm presented in +This is the Porter stemming algorithm, ported to Python from the +version coded up in ANSI C by the author. It may be be regarded +as canonical, in that it follows the algorithm presented in - Porter, 1980, An algorithm for suffix stripping, Program, Vol. 14, - no. 3, pp 130-137, +Porter, 1980, An algorithm for suffix stripping, Program, Vol. 14, +no. 3, pp 130-137, - only differing from it at the points made --DEPARTURE-- below. +only differing from it at the points made --DEPARTURE-- below. - See also https://tartarus.org/martin/PorterStemmer/ +See also https://tartarus.org/martin/PorterStemmer/ - The algorithm as described in the paper could be exactly replicated - by adjusting the points of DEPARTURE, but this is barely necessary, - because (a) the points of DEPARTURE are definitely improvements, and - (b) no encoding of the Porter stemmer I have seen is anything like - as exact as this version, even with the points of DEPARTURE! +The algorithm as described in the paper could be exactly replicated +by adjusting the points of DEPARTURE, but this is barely necessary, +because (a) the points of DEPARTURE are definitely improvements, and +(b) no encoding of the Porter stemmer I have seen is anything like +as exact as this version, even with the points of DEPARTURE! - Release 1: January 2001 +Release 1: January 2001 - :copyright: Copyright 2001 by Vivake Gupta . - :license: Public Domain ("can be used free of charge for any purpose"). +:copyright: Copyright 2001 by Vivake Gupta . +:license: Public Domain ("can be used free of charge for any purpose"). """ diff --git a/sphinx/util/tags.py b/sphinx/util/tags.py index f5cd52f4d..5cbe5989a 100644 --- a/sphinx/util/tags.py +++ b/sphinx/util/tags.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Iterator, List diff --git a/sphinx/util/template.py b/sphinx/util/template.py index 2fcd1f245..8406aaecf 100644 --- a/sphinx/util/template.py +++ b/sphinx/util/template.py @@ -1,7 +1,7 @@ """Templates utility functions for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index c9e421022..758926df4 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -1,7 +1,7 @@ """TeX escaping helper. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py index 0cffd94ff..8935f4aa5 100644 --- a/sphinx/util/typing.py +++ b/sphinx/util/typing.py @@ -1,7 +1,7 @@ """The composite types for Sphinx. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/versioning.py b/sphinx/versioning.py index 1d7eca5c6..bba0b0ef4 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -1,8 +1,8 @@ """Implements the low-level algorithms Sphinx uses for the versioning of - doctrees. +doctrees. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pickle from itertools import product, zip_longest diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py index 711c568df..3914bf67e 100644 --- a/sphinx/writers/__init__.py +++ b/sphinx/writers/__init__.py @@ -1,5 +1,5 @@ """Custom docutils writers. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index 08e142650..123846609 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -1,7 +1,7 @@ """docutils writers handling Sphinx' custom nodes. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index 1e911c8f8..752a2ef6b 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -1,7 +1,7 @@ """Experimental docutils writers for HTML5 handling Sphinx's custom nodes. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index efabba313..fdf279418 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -1,10 +1,10 @@ """Custom docutils writer for LaTeX. - Much of this code is adapted from Dave Kuhlman's "docpy" writer from his - docutils sandbox. +Much of this code is adapted from Dave Kuhlman's "docpy" writer from his +docutils sandbox. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index 1ed8463e8..9e484983a 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -1,7 +1,7 @@ """Manual page writer, extended for Sphinx custom nodes. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Iterable, cast diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index e307a36a6..5410d024a 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -1,7 +1,7 @@ """Custom docutils writer for Texinfo. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 57aa765cd..e2c49591e 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -1,7 +1,7 @@ """Custom docutils writer for plain text. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import math import os diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py index f372db024..29731d853 100644 --- a/sphinx/writers/xml.py +++ b/sphinx/writers/xml.py @@ -1,7 +1,7 @@ """Docutils-native XML and pseudo-XML writers. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any diff --git a/tests/conftest.py b/tests/conftest.py index d04956fe1..4a60dfc42 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py index 26d85df80..9fc97abd7 100644 --- a/tests/test_api_translator.py +++ b/tests/test_api_translator.py @@ -1,7 +1,7 @@ """Test the Sphinx API for translator. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_application.py b/tests/test_application.py index 00b6e7d88..de9593824 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -1,7 +1,7 @@ """Test the Sphinx class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest.mock import Mock diff --git a/tests/test_build.py b/tests/test_build.py index 87e16dadd..97898871a 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -1,7 +1,7 @@ """Test all builders. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_build_changes.py b/tests/test_build_changes.py index 7b2b1528f..6312be1a2 100644 --- a/tests/test_build_changes.py +++ b/tests/test_build_changes.py @@ -1,7 +1,7 @@ """Test the ChangesBuilder class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_build_dirhtml.py b/tests/test_build_dirhtml.py index 7cf865adc..d24ca68f2 100644 --- a/tests/test_build_dirhtml.py +++ b/tests/test_build_dirhtml.py @@ -1,7 +1,7 @@ """Test dirhtml builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import posixpath diff --git a/tests/test_build_epub.py b/tests/test_build_epub.py index 74b4dcea4..a0ecdeafd 100644 --- a/tests/test_build_epub.py +++ b/tests/test_build_epub.py @@ -1,7 +1,7 @@ """Test the HTML builder and check output against XPath. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index c98ecfa1b..1c753bd38 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -1,7 +1,7 @@ """Test the build process with gettext builder with the test root. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import gettext diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 15cba7888..732ee994e 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -1,7 +1,7 @@ """Test the HTML builder and check output against XPath. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 1ccee9571..a180be72b 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -1,7 +1,7 @@ """Test the build process with LaTeX builder with the test root. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py index 2efcd6893..7170d244a 100644 --- a/tests/test_build_linkcheck.py +++ b/tests/test_build_linkcheck.py @@ -1,7 +1,7 @@ """Test the build process with manpage builder with the test root. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import http.server diff --git a/tests/test_build_manpage.py b/tests/test_build_manpage.py index 5f92d4783..cd28957ed 100644 --- a/tests/test_build_manpage.py +++ b/tests/test_build_manpage.py @@ -1,7 +1,7 @@ """Test the build process with manpage builder with the test root. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py index 1f89a4d63..840bba0bd 100644 --- a/tests/test_build_texinfo.py +++ b/tests/test_build_texinfo.py @@ -1,7 +1,7 @@ """Test the build process with Texinfo builder with the test root. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_build_text.py b/tests/test_build_text.py index 9e4789bc5..6d1365d0d 100644 --- a/tests/test_build_text.py +++ b/tests/test_build_text.py @@ -1,7 +1,7 @@ """Test the build process with Text builder with the test root. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_builder.py b/tests/test_builder.py index 4b6c7d6e1..cd321f5ee 100644 --- a/tests/test_builder.py +++ b/tests/test_builder.py @@ -1,7 +1,7 @@ """Test the Builder class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_catalogs.py b/tests/test_catalogs.py index a4e1327af..5d2a06088 100644 --- a/tests/test_catalogs.py +++ b/tests/test_catalogs.py @@ -1,7 +1,7 @@ """Test the base build process. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import shutil diff --git a/tests/test_config.py b/tests/test_config.py index 56f223a32..1e060e24c 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -1,8 +1,8 @@ """Test the sphinx.config.Config class and its handling in the - Application class. +Application class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest import mock diff --git a/tests/test_correct_year.py b/tests/test_correct_year.py index 9214ed9f4..9d66f934f 100644 --- a/tests/test_correct_year.py +++ b/tests/test_correct_year.py @@ -1,7 +1,7 @@ """Test copyright year adjustment - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_directive_code.py b/tests/test_directive_code.py index d1f723945..371b3a6d6 100644 --- a/tests/test_directive_code.py +++ b/tests/test_directive_code.py @@ -1,7 +1,7 @@ """Test the code-block directive. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_directive_only.py b/tests/test_directive_only.py index d29e8d72f..86a8afe04 100644 --- a/tests/test_directive_only.py +++ b/tests/test_directive_only.py @@ -1,7 +1,7 @@ """Test the only directive with the test root. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_directive_other.py b/tests/test_directive_other.py index 55e745090..b654f0356 100644 --- a/tests/test_directive_other.py +++ b/tests/test_directive_other.py @@ -1,7 +1,7 @@ """Test the other directives. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_directive_patch.py b/tests/test_directive_patch.py index 31aff4a32..5e078829e 100644 --- a/tests/test_directive_patch.py +++ b/tests/test_directive_patch.py @@ -1,7 +1,7 @@ """Test the patched directives. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py index 7ecd997c4..8adb0dbd6 100644 --- a/tests/test_docutilsconf.py +++ b/tests/test_docutilsconf.py @@ -1,7 +1,7 @@ """Test docutils.conf support for several writers. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_domain_c.py b/tests/test_domain_c.py index 84a4f655d..90d1122a4 100644 --- a/tests/test_domain_c.py +++ b/tests/test_domain_c.py @@ -1,7 +1,7 @@ """Tests the C Domain - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import itertools diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 0d417c14c..565e91e23 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -1,7 +1,7 @@ """Tests the C++ Domain - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import itertools diff --git a/tests/test_domain_js.py b/tests/test_domain_js.py index 4b4be12e6..baa8b31fa 100644 --- a/tests/test_domain_js.py +++ b/tests/test_domain_js.py @@ -1,7 +1,7 @@ """Tests the JavaScript Domain - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest.mock import Mock diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py index 643ec2104..f45fdc914 100644 --- a/tests/test_domain_py.py +++ b/tests/test_domain_py.py @@ -1,7 +1,7 @@ """Tests the Python Domain - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_domain_rst.py b/tests/test_domain_rst.py index 43af04f2c..ed6dec79f 100644 --- a/tests/test_domain_rst.py +++ b/tests/test_domain_rst.py @@ -1,7 +1,7 @@ """Tests the reStructuredText domain. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from sphinx import addnodes diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py index 4acc723ab..fa56e7fde 100644 --- a/tests/test_domain_std.py +++ b/tests/test_domain_std.py @@ -1,7 +1,7 @@ """Tests the std domain - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest import mock diff --git a/tests/test_environment.py b/tests/test_environment.py index 0a47716ed..2d289781a 100644 --- a/tests/test_environment.py +++ b/tests/test_environment.py @@ -1,7 +1,7 @@ """Test the BuildEnvironment class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os import shutil diff --git a/tests/test_environment_indexentries.py b/tests/test_environment_indexentries.py index 3e68ccc90..a50506b9b 100644 --- a/tests/test_environment_indexentries.py +++ b/tests/test_environment_indexentries.py @@ -1,7 +1,7 @@ """Test the sphinx.environment.managers.indexentries. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py index 369050f86..ca9f5e3b1 100644 --- a/tests/test_environment_toctree.py +++ b/tests/test_environment_toctree.py @@ -1,7 +1,7 @@ """Test the sphinx.environment.managers.toctree. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_events.py b/tests/test_events.py index 071fa13f4..7cd6bccd0 100644 --- a/tests/test_events.py +++ b/tests/test_events.py @@ -1,7 +1,7 @@ """Test the EventManager class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py index bbddf5278..b31f64dc7 100644 --- a/tests/test_ext_apidoc.py +++ b/tests/test_ext_apidoc.py @@ -1,7 +1,7 @@ """Test the sphinx.apidoc module. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from collections import namedtuple diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py index f4e2c8ef6..149d5c890 100644 --- a/tests/test_ext_autodoc.py +++ b/tests/test_ext_autodoc.py @@ -1,8 +1,8 @@ """Test the autodoc extension. This tests mainly the Documenters; the auto - directives are tested in a test source file translated by test_build. +directives are tested in a test source file translated by test_build. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autoattribute.py b/tests/test_ext_autodoc_autoattribute.py index e8a49c2d4..560aeed1c 100644 --- a/tests/test_ext_autodoc_autoattribute.py +++ b/tests/test_ext_autodoc_autoattribute.py @@ -1,8 +1,8 @@ """Test the autodoc extension. This tests mainly the Documenters; the auto - directives are tested in a test source file translated by test_build. +directives are tested in a test source file translated by test_build. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autoclass.py b/tests/test_ext_autodoc_autoclass.py index 649211c05..0f1d8dba8 100644 --- a/tests/test_ext_autodoc_autoclass.py +++ b/tests/test_ext_autodoc_autoclass.py @@ -1,8 +1,8 @@ """Test the autodoc extension. This tests mainly the Documenters; the auto - directives are tested in a test source file translated by test_build. +directives are tested in a test source file translated by test_build. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autodata.py b/tests/test_ext_autodoc_autodata.py index b2fbaac5d..7cbd78d4a 100644 --- a/tests/test_ext_autodoc_autodata.py +++ b/tests/test_ext_autodoc_autodata.py @@ -1,8 +1,8 @@ """Test the autodoc extension. This tests mainly the Documenters; the auto - directives are tested in a test source file translated by test_build. +directives are tested in a test source file translated by test_build. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autofunction.py b/tests/test_ext_autodoc_autofunction.py index 474b3f7f3..61cc7c6db 100644 --- a/tests/test_ext_autodoc_autofunction.py +++ b/tests/test_ext_autodoc_autofunction.py @@ -1,8 +1,8 @@ """Test the autodoc extension. This tests mainly the Documenters; the auto - directives are tested in a test source file translated by test_build. +directives are tested in a test source file translated by test_build. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_autodoc_automodule.py b/tests/test_ext_autodoc_automodule.py index f99d9a364..47bd41234 100644 --- a/tests/test_ext_autodoc_automodule.py +++ b/tests/test_ext_autodoc_automodule.py @@ -1,8 +1,8 @@ """Test the autodoc extension. This tests mainly the Documenters; the auto - directives are tested in a test source file translated by test_build. +directives are tested in a test source file translated by test_build. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autoproperty.py b/tests/test_ext_autodoc_autoproperty.py index 033e10ead..b3f7403ec 100644 --- a/tests/test_ext_autodoc_autoproperty.py +++ b/tests/test_ext_autodoc_autoproperty.py @@ -1,8 +1,8 @@ """Test the autodoc extension. This tests mainly the Documenters; the auto - directives are tested in a test source file translated by test_build. +directives are tested in a test source file translated by test_build. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_configs.py b/tests/test_ext_autodoc_configs.py index 8f5bb10a1..46bd9e767 100644 --- a/tests/test_ext_autodoc_configs.py +++ b/tests/test_ext_autodoc_configs.py @@ -1,7 +1,7 @@ """Test the autodoc extension. This tests mainly for config variables - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import platform diff --git a/tests/test_ext_autodoc_events.py b/tests/test_ext_autodoc_events.py index 02d0c739e..d7c69c258 100644 --- a/tests/test_ext_autodoc_events.py +++ b/tests/test_ext_autodoc_events.py @@ -1,7 +1,7 @@ """Test the autodoc extension. This tests mainly for autodoc events - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_autodoc_mock.py b/tests/test_ext_autodoc_mock.py index c2c520457..51c8bedda 100644 --- a/tests/test_ext_autodoc_mock.py +++ b/tests/test_ext_autodoc_mock.py @@ -1,7 +1,7 @@ """Test the autodoc extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import abc diff --git a/tests/test_ext_autodoc_preserve_defaults.py b/tests/test_ext_autodoc_preserve_defaults.py index d00d4e774..56bea8fbc 100644 --- a/tests/test_ext_autodoc_preserve_defaults.py +++ b/tests/test_ext_autodoc_preserve_defaults.py @@ -1,7 +1,7 @@ """Test the autodoc extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_private_members.py b/tests/test_ext_autodoc_private_members.py index 761c48c52..beb0ec373 100644 --- a/tests/test_ext_autodoc_private_members.py +++ b/tests/test_ext_autodoc_private_members.py @@ -1,7 +1,7 @@ """Test the autodoc extension. This tests mainly for private-members option. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_autosectionlabel.py b/tests/test_ext_autosectionlabel.py index 0a8732a12..f81031d4b 100644 --- a/tests/test_ext_autosectionlabel.py +++ b/tests/test_ext_autosectionlabel.py @@ -1,7 +1,7 @@ """Test sphinx.ext.autosectionlabel extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py index 0a9a965e0..53aaf95ef 100644 --- a/tests/test_ext_autosummary.py +++ b/tests/test_ext_autosummary.py @@ -1,7 +1,7 @@ """Test the autosummary extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_coverage.py b/tests/test_ext_coverage.py index ad96cafbd..0597b12d7 100644 --- a/tests/test_ext_coverage.py +++ b/tests/test_ext_coverage.py @@ -1,7 +1,7 @@ """Test the coverage builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pickle diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index c1c02fd0e..1bd86919a 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -1,7 +1,7 @@ """Test the doctest extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os from collections import Counter diff --git a/tests/test_ext_duration.py b/tests/test_ext_duration.py index 71b7a8f9c..5b459fbec 100644 --- a/tests/test_ext_duration.py +++ b/tests/test_ext_duration.py @@ -1,7 +1,7 @@ """Test sphinx.ext.duration extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_githubpages.py b/tests/test_ext_githubpages.py index d3d703fb1..8067a5b98 100644 --- a/tests/test_ext_githubpages.py +++ b/tests/test_ext_githubpages.py @@ -1,7 +1,7 @@ """Test sphinx.ext.githubpages extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py index f6812a9ce..0d6f1de6d 100644 --- a/tests/test_ext_graphviz.py +++ b/tests/test_ext_graphviz.py @@ -1,7 +1,7 @@ """Test sphinx.ext.graphviz extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_ifconfig.py b/tests/test_ext_ifconfig.py index e225ff76a..3de09e367 100644 --- a/tests/test_ext_ifconfig.py +++ b/tests/test_ext_ifconfig.py @@ -1,7 +1,7 @@ """Test sphinx.ext.ifconfig extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_imgconverter.py b/tests/test_ext_imgconverter.py index 5e5f00b15..d8a152e8b 100644 --- a/tests/test_ext_imgconverter.py +++ b/tests/test_ext_imgconverter.py @@ -1,7 +1,7 @@ """Test sphinx.ext.imgconverter extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py index 2d1b61e62..5b8ccdaff 100644 --- a/tests/test_ext_inheritance_diagram.py +++ b/tests/test_ext_inheritance_diagram.py @@ -1,7 +1,7 @@ """Test sphinx.ext.inheritance_diagram extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py index f363c6c96..08525d889 100644 --- a/tests/test_ext_intersphinx.py +++ b/tests/test_ext_intersphinx.py @@ -1,7 +1,7 @@ """Test the intersphinx extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import http.server diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index 18ad0968e..b293ca98e 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -1,7 +1,7 @@ """Test math extensions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_napoleon.py b/tests/test_ext_napoleon.py index 8ce4b542d..9f51ccfd5 100644 --- a/tests/test_ext_napoleon.py +++ b/tests/test_ext_napoleon.py @@ -1,8 +1,8 @@ """Tests for :mod:`sphinx.ext.napoleon.__init__` module. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index 271e08333..314c12dec 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -1,8 +1,8 @@ """Tests for :mod:`sphinx.ext.napoleon.docstring` module. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_napoleon_iterators.py b/tests/test_ext_napoleon_iterators.py index 74618f740..c3b07895c 100644 --- a/tests/test_ext_napoleon_iterators.py +++ b/tests/test_ext_napoleon_iterators.py @@ -1,8 +1,8 @@ """Tests for :mod:`sphinx.ext.napoleon.iterators` module. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest import TestCase diff --git a/tests/test_ext_todo.py b/tests/test_ext_todo.py index 93c0cb7ca..f16fddd55 100644 --- a/tests/test_ext_todo.py +++ b/tests/test_ext_todo.py @@ -1,7 +1,7 @@ """Test sphinx.ext.todo extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py index 688fa7607..44c2efbf3 100644 --- a/tests/test_ext_viewcode.py +++ b/tests/test_ext_viewcode.py @@ -1,7 +1,7 @@ """Test sphinx.ext.viewcode extension. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_extension.py b/tests/test_extension.py index ca35e0ae5..1a6993fc5 100644 --- a/tests/test_extension.py +++ b/tests/test_extension.py @@ -1,7 +1,7 @@ """Test sphinx.extension module. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index 0b0687196..59a38f4fe 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -1,7 +1,7 @@ """Test the Pygments highlighting bridge. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest import mock diff --git a/tests/test_intl.py b/tests/test_intl.py index 8fccb33b6..83410d555 100644 --- a/tests/test_intl.py +++ b/tests/test_intl.py @@ -1,8 +1,8 @@ """Test message patching for internationalization purposes. Runs the text - builder in the test root. +builder in the test root. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_locale.py b/tests/test_locale.py index f88e17b78..909ce3480 100644 --- a/tests/test_locale.py +++ b/tests/test_locale.py @@ -1,7 +1,7 @@ """Test locale. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_markup.py b/tests/test_markup.py index c7c955048..a0e6e4d59 100644 --- a/tests/test_markup.py +++ b/tests/test_markup.py @@ -1,7 +1,7 @@ """Test various Sphinx-specific markup extensions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_metadata.py b/tests/test_metadata.py index 0092158aa..df77c0320 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1,7 +1,7 @@ """Test our handling of metadata in files with bibliographic metadata. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ # adapted from an example of bibliographic metadata at diff --git a/tests/test_parser.py b/tests/test_parser.py index 3ff10eff8..473048ce6 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -1,7 +1,7 @@ """Tests parsers module. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest.mock import Mock, patch diff --git a/tests/test_project.py b/tests/test_project.py index cd48c33a1..0d962e84a 100644 --- a/tests/test_project.py +++ b/tests/test_project.py @@ -1,7 +1,7 @@ """Tests project module. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from collections import OrderedDict diff --git a/tests/test_pycode.py b/tests/test_pycode.py index 1de3f615d..3c132aaee 100644 --- a/tests/test_pycode.py +++ b/tests/test_pycode.py @@ -1,7 +1,7 @@ """Test pycode. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_pycode_ast.py b/tests/test_pycode_ast.py index 6cf8b77ee..68c03dc2f 100644 --- a/tests/test_pycode_ast.py +++ b/tests/test_pycode_ast.py @@ -1,7 +1,7 @@ """Test pycode.ast - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_pycode_parser.py b/tests/test_pycode_parser.py index c1456a0a6..3ad1486da 100644 --- a/tests/test_pycode_parser.py +++ b/tests/test_pycode_parser.py @@ -1,7 +1,7 @@ """Test pycode.parser. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from sphinx.pycode.parser import Parser diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py index c4eaed0ae..e2c5af3aa 100644 --- a/tests/test_quickstart.py +++ b/tests/test_quickstart.py @@ -1,7 +1,7 @@ """Test the sphinx.quickstart module. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import time diff --git a/tests/test_roles.py b/tests/test_roles.py index 5cf78f18d..e29df9e7f 100644 --- a/tests/test_roles.py +++ b/tests/test_roles.py @@ -1,7 +1,7 @@ """Test sphinx.roles - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest.mock import Mock diff --git a/tests/test_search.py b/tests/test_search.py index f58164141..7957a2b11 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -1,7 +1,7 @@ """Test the search index builder. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from collections import namedtuple diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py index d1bbb5823..18a2ae368 100644 --- a/tests/test_setup_command.py +++ b/tests/test_setup_command.py @@ -1,7 +1,7 @@ """Test setup_command for distutils. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_smartquotes.py b/tests/test_smartquotes.py index c7920f26a..eb70c4058 100644 --- a/tests/test_smartquotes.py +++ b/tests/test_smartquotes.py @@ -1,7 +1,7 @@ """Test smart quotes. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_templating.py b/tests/test_templating.py index f519b5e8d..5be71e07b 100644 --- a/tests/test_templating.py +++ b/tests/test_templating.py @@ -1,7 +1,7 @@ """Test templating. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_theming.py b/tests/test_theming.py index 4178114c9..557ea0a93 100644 --- a/tests/test_theming.py +++ b/tests/test_theming.py @@ -1,7 +1,7 @@ """Test the Theme class. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_toctree.py b/tests/test_toctree.py index 8e422041b..60c343547 100644 --- a/tests/test_toctree.py +++ b/tests/test_toctree.py @@ -1,7 +1,7 @@ """Test the HTML builder and check output against XPath. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_transforms_post_transforms.py b/tests/test_transforms_post_transforms.py index e7dba7619..fa5c063e7 100644 --- a/tests/test_transforms_post_transforms.py +++ b/tests/test_transforms_post_transforms.py @@ -1,7 +1,7 @@ """Tests the post_transforms - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_transforms_post_transforms_code.py b/tests/test_transforms_post_transforms_code.py index c890df294..0029fbead 100644 --- a/tests/test_transforms_post_transforms_code.py +++ b/tests/test_transforms_post_transforms_code.py @@ -1,6 +1,6 @@ """ - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_util.py b/tests/test_util.py index 76ae43bcd..470f365d8 100644 --- a/tests/test_util.py +++ b/tests/test_util.py @@ -1,7 +1,7 @@ """Tests util functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_util_docstrings.py b/tests/test_util_docstrings.py index a8ac6912e..af09a8cbe 100644 --- a/tests/test_util_docstrings.py +++ b/tests/test_util_docstrings.py @@ -1,7 +1,7 @@ """Test sphinx.util.docstrings. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from sphinx.util.docstrings import prepare_commentdoc, prepare_docstring, separate_metadata diff --git a/tests/test_util_docutils.py b/tests/test_util_docutils.py index 3af3861f9..2d9c805b7 100644 --- a/tests/test_util_docutils.py +++ b/tests/test_util_docutils.py @@ -1,7 +1,7 @@ """Tests util.utils functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_util_fileutil.py b/tests/test_util_fileutil.py index d1d4297c0..52f189bfe 100644 --- a/tests/test_util_fileutil.py +++ b/tests/test_util_fileutil.py @@ -1,7 +1,7 @@ """Tests sphinx.util.fileutil functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from unittest import mock diff --git a/tests/test_util_i18n.py b/tests/test_util_i18n.py index 49118daae..bf5913dbd 100644 --- a/tests/test_util_i18n.py +++ b/tests/test_util_i18n.py @@ -1,7 +1,7 @@ """Test i18n util. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import datetime diff --git a/tests/test_util_images.py b/tests/test_util_images.py index 7b21af430..43a2e2597 100644 --- a/tests/test_util_images.py +++ b/tests/test_util_images.py @@ -1,7 +1,7 @@ """Test images util. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 02e7244cd..8eaaba38f 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -1,7 +1,7 @@ """Tests util.inspect functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import ast diff --git a/tests/test_util_inventory.py b/tests/test_util_inventory.py index 1aae84589..9189485a2 100644 --- a/tests/test_util_inventory.py +++ b/tests/test_util_inventory.py @@ -1,7 +1,7 @@ """Test inventory util functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import posixpath diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py index 42bfd137b..4a1366bc0 100644 --- a/tests/test_util_logging.py +++ b/tests/test_util_logging.py @@ -1,7 +1,7 @@ """Test logging util. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import codecs diff --git a/tests/test_util_matching.py b/tests/test_util_matching.py index 4a7fd28dc..bb5896fa0 100644 --- a/tests/test_util_matching.py +++ b/tests/test_util_matching.py @@ -1,7 +1,7 @@ """Tests sphinx.util.matching functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from sphinx.util.matching import Matcher, compile_matchers diff --git a/tests/test_util_nodes.py b/tests/test_util_nodes.py index 71e2d637a..4f404fb4c 100644 --- a/tests/test_util_nodes.py +++ b/tests/test_util_nodes.py @@ -1,7 +1,7 @@ """Tests uti.nodes functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from textwrap import dedent from typing import Any diff --git a/tests/test_util_rst.py b/tests/test_util_rst.py index f80f7cdef..e2c87cf2e 100644 --- a/tests/test_util_rst.py +++ b/tests/test_util_rst.py @@ -1,7 +1,7 @@ """Tests sphinx.util.rst functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from docutils.statemachine import StringList diff --git a/tests/test_util_template.py b/tests/test_util_template.py index 5380716aa..b49d44dfd 100644 --- a/tests/test_util_template.py +++ b/tests/test_util_template.py @@ -1,7 +1,7 @@ """Tests sphinx.util.template functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from sphinx.util.template import ReSTRenderer diff --git a/tests/test_util_typing.py b/tests/test_util_typing.py index 470524e23..1a7bbb054 100644 --- a/tests/test_util_typing.py +++ b/tests/test_util_typing.py @@ -1,7 +1,7 @@ """Tests util.typing functions. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_versioning.py b/tests/test_versioning.py index af00d56b1..b41a3f07b 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -1,7 +1,7 @@ """Test the versioning implementation. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pickle diff --git a/tests/test_writer_latex.py b/tests/test_writer_latex.py index 0ab8511da..cd2052719 100644 --- a/tests/test_writer_latex.py +++ b/tests/test_writer_latex.py @@ -1,7 +1,7 @@ """Test the LaTeX writer - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import pytest diff --git a/utils/checks.py b/utils/checks.py index f69242614..952ab8afd 100644 --- a/utils/checks.py +++ b/utils/checks.py @@ -1,7 +1,7 @@ """Custom, Sphinx-only flake8 plugins. - :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/utils/doclinter.py b/utils/doclinter.py index 93351becb..7b3c2f91d 100644 --- a/utils/doclinter.py +++ b/utils/doclinter.py @@ -1,7 +1,7 @@ """A linter for Sphinx docs - :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ import os diff --git a/utils/jssplitter_generator.py b/utils/jssplitter_generator.py index c62ceb37f..0f2f3759a 100644 --- a/utils/jssplitter_generator.py +++ b/utils/jssplitter_generator.py @@ -114,10 +114,10 @@ console.log(' ... ok\\n') python_src = '''\ """Provides Python compatible word splitter to JavaScript - DO NOT EDIT. This is generated by utils/jssplitter_generator.py +DO NOT EDIT. This is generated by utils/jssplitter_generator.py - :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ splitter_code = """ From b691ebcc3e440a678cd28432fed7279fa647e9cd Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 02:57:02 +0000 Subject: [PATCH 4/9] Conform to PEP 257 summary line conventions --- sphinx/builders/epub3.py | 1 + sphinx/domains/__init__.py | 4 +++- sphinx/errors.py | 3 +-- sphinx/ext/apidoc.py | 4 +++- sphinx/ext/autodoc/__init__.py | 4 +++- sphinx/ext/autodoc/preserve_defaults.py | 4 +++- sphinx/ext/autosummary/__init__.py | 7 ++++--- sphinx/ext/autosummary/generate.py | 4 +++- sphinx/ext/coverage.py | 6 ++++-- sphinx/ext/doctest.py | 5 +++-- sphinx/ext/extlinks.py | 3 +-- sphinx/ext/graphviz.py | 3 +-- sphinx/ext/ifconfig.py | 4 +++- sphinx/ext/mathjax.py | 8 +++++--- sphinx/ext/todo.py | 9 +++++---- sphinx/setup_command.py | 3 +-- sphinx/util/docfields.py | 4 +++- sphinx/util/jsdump.py | 1 + sphinx/util/smartypants.py | 4 +++- sphinx/versioning.py | 3 +-- tests/ext_napoleon_pep526_data_google.py | 3 +-- tests/ext_napoleon_pep526_data_numpy.py | 3 +-- tests/test_config.py | 3 +-- tests/test_ext_autodoc.py | 6 ++++-- tests/test_ext_autodoc_autoattribute.py | 6 ++++-- tests/test_ext_autodoc_autoclass.py | 6 ++++-- tests/test_ext_autodoc_autodata.py | 6 ++++-- tests/test_ext_autodoc_autofunction.py | 6 ++++-- tests/test_ext_autodoc_automodule.py | 6 ++++-- tests/test_ext_autodoc_autoproperty.py | 6 ++++-- tests/test_intl.py | 5 +++-- 31 files changed, 86 insertions(+), 54 deletions(-) diff --git a/sphinx/builders/epub3.py b/sphinx/builders/epub3.py index b413dce07..d172133ca 100644 --- a/sphinx/builders/epub3.py +++ b/sphinx/builders/epub3.py @@ -1,4 +1,5 @@ """Build epub3 files. + Originally derived from epub.py. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py index 9b3098e24..ef41a53fb 100644 --- a/sphinx/domains/__init__.py +++ b/sphinx/domains/__init__.py @@ -1,4 +1,6 @@ -"""Support for domains, which are groupings of description directives +"""Support for domains. + +Domains are groupings of description directives and roles describing e.g. constructs of one programming language. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/errors.py b/sphinx/errors.py index 30edd88a2..7ac997d3a 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,5 +1,4 @@ -"""Contains SphinxError and a few subclasses (in an extra module to avoid -circular import problems). +"""Contains SphinxError and a few subclasses. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py index 6b93656f4..378eca221 100644 --- a/sphinx/ext/apidoc.py +++ b/sphinx/ext/apidoc.py @@ -1,4 +1,6 @@ -"""Parses a directory tree looking for Python modules and packages and creates +"""Creates reST files corresponding to Python modules for code documentation. + +Parses a directory tree looking for Python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index (named modules.). diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index a66c76b45..0b794bbb9 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1,4 +1,6 @@ -"""Automatically insert docstrings for functions, classes or whole modules into +"""Extension to create automatic documentation from code docstrings. + +Automatically insert docstrings for functions, classes or whole modules into the doctree, thus avoiding duplication between docstrings and documentation for those who like elaborate docstrings. diff --git a/sphinx/ext/autodoc/preserve_defaults.py b/sphinx/ext/autodoc/preserve_defaults.py index fe71d088e..5526ada6d 100644 --- a/sphinx/ext/autodoc/preserve_defaults.py +++ b/sphinx/ext/autodoc/preserve_defaults.py @@ -1,4 +1,6 @@ -"""Preserve the default argument values of function signatures in source code +"""Preserve function defaults. + +Preserve the default argument values of function signatures in source code and keep them not evaluated for readability. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index 69d5a89a4..5765300df 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -1,6 +1,7 @@ -"""Sphinx extension that adds an autosummary:: directive, which can be -used to generate function/method/attribute/etc. summary lists, similar -to those output eg. by Epydoc and other API doc generation tools. +"""Extension that adds an autosummary:: directive. + +The directive can be used to generate function/method/attribute/etc. summary +lists, similar to those output eg. by Epydoc and other API doc generation tools. An :autolink: role is also provided. diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index 1912e3b08..092efd13b 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -1,4 +1,6 @@ -"""Usable as a library or script to generate automatic RST source files for +"""Generates reST source files for autosummary. + +Usable as a library or script to generate automatic RST source files for items referred to in autosummary:: directives. Each generated RST file contains a single auto*:: directive which diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index a69bd6748..0cdbe80df 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -1,5 +1,7 @@ -"""Check Python modules and C API for coverage. Mostly written by Josip -Dzolonga for the Google Highly Open Participation contest. +"""Check Python modules and C API for coverage. + +Mostly written by Josip Dzolonga for the Google Highly Open Participation +contest. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index c1d3c5dd0..8a7b94a93 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -1,5 +1,6 @@ -"""Mimic doctest by automatically executing code snippets and checking -their results. +"""Mimic doctest in Sphinx. + +The extension automatically execute code snippets and checks their results. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py index 74f0ea5ed..452c85034 100644 --- a/sphinx/ext/extlinks.py +++ b/sphinx/ext/extlinks.py @@ -1,5 +1,4 @@ -"""Extension to save typing and prevent hard-coding of base URLs in the reST -files. +"""Extension to save typing and prevent hard-coding of base URLs in reST files. This adds a new config value called ``extlinks`` that is created like this:: diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index 189463d44..0cb85a2b9 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -1,5 +1,4 @@ -"""Allow graphviz-formatted graphs to be included in Sphinx-generated -documents inline. +"""Allow graphviz-formatted graphs to be included inline in generated documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 244fa8187..0d97a1189 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -1,4 +1,6 @@ -"""Provides the ``ifconfig`` directive that allows to write documentation +"""Provides the ``ifconfig`` directive. + +The ``ifconfig`` directive enables writing documentation that is included depending on configuration variables. Usage:: diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index a411cd558..6b4a2db13 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -1,6 +1,8 @@ -"""Allow `MathJax `_ to be used to display math in -Sphinx's HTML writer -- requires the MathJax JavaScript library on your -webserver/computer. +"""Allow `MathJax`_ to be used to display math in Sphinx's HTML writer. + +This requires the MathJax JavaScript library on your webserver/computer. + +.. _MathJax: https://www.mathjax.org/ :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index d4234c06b..3f27c6850 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -1,7 +1,8 @@ -"""Allow todos to be inserted into your documentation. Inclusion of todos can -be switched of by a configuration variable. The todolist directive collects -all todos of your project and lists them along with a backlink to the -original location. +"""Allow todos to be inserted into your documentation. + +Inclusion of todos can be switched of by a configuration variable. +The todolist directive collects all todos of your project and lists them along +with a backlink to the original location. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index 40254cce5..d69a96011 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -1,5 +1,4 @@ -"""Setuptools/distutils commands to assist the building of sphinx -documentation. +"""Setuptools/distutils commands to assist the building of sphinx documentation. :author: Sebastian Wiesner :contact: basti.wiesner@gmx.net diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index 81887126a..6617465da 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -1,4 +1,6 @@ -""""Doc fields" are reST field lists in object descriptions that will +"""Utility code for "Doc fields". + +"Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index ae0075a66..0a685a0ea 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -1,4 +1,5 @@ """This module implements a simple JavaScript serializer. + Uses the basestring encode function from simplejson by Bob Ippolito. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/smartypants.py b/sphinx/util/smartypants.py index c1d9c4492..bc4171631 100644 --- a/sphinx/util/smartypants.py +++ b/sphinx/util/smartypants.py @@ -1,4 +1,6 @@ -"""This is extracted (with minor adaptations for flake8 compliance) from +"""Deprecated backport of docutils.utils.smartquotes. + +This is extracted (with minor adaptations for flake8 compliance) from docutils’ docutils/utils/smartquotes.py as of revision 8097 (30 May 2017), in order to backport for Sphinx usage with Docutils < 0.14 extra language configurations and fixes. Replaces earlier smartypants version as used up diff --git a/sphinx/versioning.py b/sphinx/versioning.py index bba0b0ef4..b09590ffc 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -1,5 +1,4 @@ -"""Implements the low-level algorithms Sphinx uses for the versioning of -doctrees. +"""Implements the low-level algorithms Sphinx uses for versioning doctrees. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/ext_napoleon_pep526_data_google.py b/tests/ext_napoleon_pep526_data_google.py index 0a4676d89..e9a00b72c 100644 --- a/tests/ext_napoleon_pep526_data_google.py +++ b/tests/ext_napoleon_pep526_data_google.py @@ -1,5 +1,4 @@ -""" -Test module for napoleon PEP 526 compatibility with google style +"""Test module for napoleon PEP 526 compatibility with google style """ module_level_var: int = 99 diff --git a/tests/ext_napoleon_pep526_data_numpy.py b/tests/ext_napoleon_pep526_data_numpy.py index a421f53fe..6d31973f5 100644 --- a/tests/ext_napoleon_pep526_data_numpy.py +++ b/tests/ext_napoleon_pep526_data_numpy.py @@ -1,5 +1,4 @@ -""" -Test module for napoleon PEP 526 compatibility with numpy style +"""Test module for napoleon PEP 526 compatibility with numpy style """ module_level_var: int = 99 diff --git a/tests/test_config.py b/tests/test_config.py index 1e060e24c..48b941b94 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -1,5 +1,4 @@ -"""Test the sphinx.config.Config class and its handling in the -Application class. +"""Test the sphinx.config.Config class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py index 149d5c890..60eb3b925 100644 --- a/tests/test_ext_autodoc.py +++ b/tests/test_ext_autodoc.py @@ -1,5 +1,7 @@ -"""Test the autodoc extension. This tests mainly the Documenters; the auto -directives are tested in a test source file translated by test_build. +"""Test the autodoc extension. + +This tests mainly the Documenters; the auto directives are tested in a test +source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_autoattribute.py b/tests/test_ext_autodoc_autoattribute.py index 560aeed1c..692f06f6d 100644 --- a/tests/test_ext_autodoc_autoattribute.py +++ b/tests/test_ext_autodoc_autoattribute.py @@ -1,5 +1,7 @@ -"""Test the autodoc extension. This tests mainly the Documenters; the auto -directives are tested in a test source file translated by test_build. +"""Test the autodoc extension. + +This tests mainly the Documenters; the auto directives are tested in a test +source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_autoclass.py b/tests/test_ext_autodoc_autoclass.py index 0f1d8dba8..064f8136f 100644 --- a/tests/test_ext_autodoc_autoclass.py +++ b/tests/test_ext_autodoc_autoclass.py @@ -1,5 +1,7 @@ -"""Test the autodoc extension. This tests mainly the Documenters; the auto -directives are tested in a test source file translated by test_build. +"""Test the autodoc extension. + +This tests mainly the Documenters; the auto directives are tested in a test +source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_autodata.py b/tests/test_ext_autodoc_autodata.py index 7cbd78d4a..709797ff7 100644 --- a/tests/test_ext_autodoc_autodata.py +++ b/tests/test_ext_autodoc_autodata.py @@ -1,5 +1,7 @@ -"""Test the autodoc extension. This tests mainly the Documenters; the auto -directives are tested in a test source file translated by test_build. +"""Test the autodoc extension. + +This tests mainly the Documenters; the auto directives are tested in a test +source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_autofunction.py b/tests/test_ext_autodoc_autofunction.py index 61cc7c6db..60b8bf89c 100644 --- a/tests/test_ext_autodoc_autofunction.py +++ b/tests/test_ext_autodoc_autofunction.py @@ -1,5 +1,7 @@ -"""Test the autodoc extension. This tests mainly the Documenters; the auto -directives are tested in a test source file translated by test_build. +"""Test the autodoc extension. + +This tests mainly the Documenters; the auto directives are tested in a test +source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_automodule.py b/tests/test_ext_autodoc_automodule.py index 47bd41234..6333ba5c0 100644 --- a/tests/test_ext_autodoc_automodule.py +++ b/tests/test_ext_autodoc_automodule.py @@ -1,5 +1,7 @@ -"""Test the autodoc extension. This tests mainly the Documenters; the auto -directives are tested in a test source file translated by test_build. +"""Test the autodoc extension. + +This tests mainly the Documenters; the auto directives are tested in a test +source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_autoproperty.py b/tests/test_ext_autodoc_autoproperty.py index b3f7403ec..765ba30ac 100644 --- a/tests/test_ext_autodoc_autoproperty.py +++ b/tests/test_ext_autodoc_autoproperty.py @@ -1,5 +1,7 @@ -"""Test the autodoc extension. This tests mainly the Documenters; the auto -directives are tested in a test source file translated by test_build. +"""Test the autodoc extension. + +This tests mainly the Documenters; the auto directives are tested in a test +source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_intl.py b/tests/test_intl.py index 83410d555..b125a0d17 100644 --- a/tests/test_intl.py +++ b/tests/test_intl.py @@ -1,5 +1,6 @@ -"""Test message patching for internationalization purposes. Runs the text -builder in the test root. +"""Test message patching for internationalization purposes. + +Runs the text builder in the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. From 6bb7b891a16fbcd5fad1f88fb472505549b9c084 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 02:59:02 +0000 Subject: [PATCH 5/9] Remove copyright and licence fields --- sphinx/__init__.py | 3 --- sphinx/__main__.py | 3 --- sphinx/addnodes.py | 3 --- sphinx/application.py | 3 --- sphinx/builders/__init__.py | 3 --- sphinx/builders/_epub_base.py | 3 --- sphinx/builders/changes.py | 3 --- sphinx/builders/dirhtml.py | 3 --- sphinx/builders/dummy.py | 3 --- sphinx/builders/epub3.py | 3 --- sphinx/builders/gettext.py | 3 --- sphinx/builders/html/__init__.py | 3 --- sphinx/builders/html/transforms.py | 3 --- sphinx/builders/latex/__init__.py | 3 --- sphinx/builders/latex/constants.py | 3 --- sphinx/builders/latex/nodes.py | 3 --- sphinx/builders/latex/theming.py | 3 --- sphinx/builders/latex/transforms.py | 3 --- sphinx/builders/latex/util.py | 3 --- sphinx/builders/linkcheck.py | 3 --- sphinx/builders/manpage.py | 3 --- sphinx/builders/singlehtml.py | 3 --- sphinx/builders/texinfo.py | 3 --- sphinx/builders/text.py | 3 --- sphinx/builders/xml.py | 3 --- sphinx/cmd/__init__.py | 3 --- sphinx/cmd/build.py | 3 --- sphinx/cmd/make_mode.py | 3 --- sphinx/cmd/quickstart.py | 3 --- sphinx/config.py | 3 --- sphinx/deprecation.py | 3 --- sphinx/directives/__init__.py | 3 --- sphinx/directives/code.py | 5 ----- sphinx/directives/other.py | 5 ----- sphinx/directives/patches.py | 5 ----- sphinx/domains/__init__.py | 3 --- sphinx/domains/c.py | 3 --- sphinx/domains/changeset.py | 3 --- sphinx/domains/citation.py | 3 --- sphinx/domains/cpp.py | 3 --- sphinx/domains/index.py | 3 --- sphinx/domains/javascript.py | 3 --- sphinx/domains/math.py | 3 --- sphinx/domains/python.py | 3 --- sphinx/domains/rst.py | 3 --- sphinx/domains/std.py | 3 --- sphinx/environment/__init__.py | 3 --- sphinx/environment/adapters/__init__.py | 3 --- sphinx/environment/adapters/asset.py | 3 --- sphinx/environment/adapters/indexentries.py | 3 --- sphinx/environment/adapters/toctree.py | 3 --- sphinx/environment/collectors/__init__.py | 3 --- sphinx/environment/collectors/asset.py | 3 --- sphinx/environment/collectors/dependencies.py | 3 --- sphinx/environment/collectors/metadata.py | 3 --- sphinx/environment/collectors/title.py | 3 --- sphinx/environment/collectors/toctree.py | 3 --- sphinx/errors.py | 3 --- sphinx/events.py | 3 --- sphinx/ext/__init__.py | 3 --- sphinx/ext/apidoc.py | 3 --- sphinx/ext/autodoc/__init__.py | 3 --- sphinx/ext/autodoc/deprecated.py | 3 --- sphinx/ext/autodoc/directive.py | 5 ----- sphinx/ext/autodoc/importer.py | 3 --- sphinx/ext/autodoc/mock.py | 3 --- sphinx/ext/autodoc/preserve_defaults.py | 3 --- sphinx/ext/autodoc/type_comment.py | 3 --- sphinx/ext/autodoc/typehints.py | 3 --- sphinx/ext/autosectionlabel.py | 3 --- sphinx/ext/autosummary/__init__.py | 3 --- sphinx/ext/autosummary/generate.py | 3 --- sphinx/ext/coverage.py | 3 --- sphinx/ext/doctest.py | 3 --- sphinx/ext/duration.py | 3 --- sphinx/ext/extlinks.py | 3 --- sphinx/ext/githubpages.py | 3 --- sphinx/ext/graphviz.py | 3 --- sphinx/ext/ifconfig.py | 3 --- sphinx/ext/imgconverter.py | 3 --- sphinx/ext/imgmath.py | 3 --- sphinx/ext/inheritance_diagram.py | 3 --- sphinx/ext/intersphinx.py | 3 --- sphinx/ext/linkcode.py | 3 --- sphinx/ext/mathjax.py | 3 --- sphinx/ext/napoleon/__init__.py | 3 --- sphinx/ext/napoleon/docstring.py | 3 --- sphinx/ext/napoleon/iterators.py | 3 --- sphinx/ext/todo.py | 3 --- sphinx/ext/viewcode.py | 3 --- sphinx/extension.py | 3 --- sphinx/highlighting.py | 3 --- sphinx/io.py | 3 --- sphinx/jinja2glue.py | 3 --- sphinx/locale/__init__.py | 3 --- sphinx/parsers.py | 3 --- sphinx/project.py | 3 --- sphinx/pycode/__init__.py | 3 --- sphinx/pycode/ast.py | 3 --- sphinx/pycode/parser.py | 3 --- sphinx/pygments_styles.py | 3 --- sphinx/registry.py | 3 --- sphinx/roles.py | 3 --- sphinx/search/__init__.py | 3 --- sphinx/search/da.py | 3 --- sphinx/search/de.py | 3 --- sphinx/search/en.py | 3 --- sphinx/search/es.py | 3 --- sphinx/search/fi.py | 3 --- sphinx/search/fr.py | 3 --- sphinx/search/hu.py | 3 --- sphinx/search/it.py | 3 --- sphinx/search/ja.py | 3 --- sphinx/search/jssplitter.py | 3 --- sphinx/search/nl.py | 3 --- sphinx/search/no.py | 3 --- sphinx/search/pt.py | 3 --- sphinx/search/ro.py | 3 --- sphinx/search/ru.py | 3 --- sphinx/search/sv.py | 3 --- sphinx/search/tr.py | 3 --- sphinx/search/zh.py | 3 --- sphinx/setup_command.py | 5 +---- sphinx/testing/__init__.py | 3 --- sphinx/testing/comparer.py | 3 --- sphinx/testing/fixtures.py | 3 --- sphinx/testing/path.py | 5 ----- sphinx/testing/restructuredtext.py | 5 ----- sphinx/testing/util.py | 3 --- sphinx/theming.py | 3 --- sphinx/transforms/__init__.py | 3 --- sphinx/transforms/compact_bullet_list.py | 3 --- sphinx/transforms/i18n.py | 3 --- sphinx/transforms/post_transforms/__init__.py | 3 --- sphinx/transforms/post_transforms/code.py | 3 --- sphinx/transforms/post_transforms/images.py | 3 --- sphinx/transforms/references.py | 3 --- sphinx/util/__init__.py | 3 --- sphinx/util/build_phase.py | 3 --- sphinx/util/cfamily.py | 3 --- sphinx/util/compat.py | 3 --- sphinx/util/console.py | 3 --- sphinx/util/docfields.py | 3 --- sphinx/util/docstrings.py | 3 --- sphinx/util/docutils.py | 3 --- sphinx/util/fileutil.py | 3 --- sphinx/util/i18n.py | 3 --- sphinx/util/images.py | 3 --- sphinx/util/inspect.py | 3 --- sphinx/util/inventory.py | 3 --- sphinx/util/jsdump.py | 3 --- sphinx/util/logging.py | 3 --- sphinx/util/matching.py | 3 --- sphinx/util/math.py | 3 --- sphinx/util/nodes.py | 3 --- sphinx/util/osutil.py | 3 --- sphinx/util/parallel.py | 3 --- sphinx/util/png.py | 3 --- sphinx/util/pycompat.py | 3 --- sphinx/util/requests.py | 3 --- sphinx/util/rst.py | 3 --- sphinx/util/stemmer/__init__.py | 3 --- sphinx/util/stemmer/porter.py | 2 +- sphinx/util/tags.py | 5 ----- sphinx/util/template.py | 3 --- sphinx/util/texescape.py | 3 --- sphinx/util/typing.py | 3 --- sphinx/versioning.py | 3 --- sphinx/writers/__init__.py | 3 --- sphinx/writers/html.py | 3 --- sphinx/writers/html5.py | 3 --- sphinx/writers/latex.py | 3 --- sphinx/writers/manpage.py | 3 --- sphinx/writers/texinfo.py | 3 --- sphinx/writers/text.py | 3 --- sphinx/writers/xml.py | 3 --- tests/conftest.py | 5 ----- tests/test_api_translator.py | 3 --- tests/test_application.py | 3 --- tests/test_build.py | 3 --- tests/test_build_changes.py | 3 --- tests/test_build_dirhtml.py | 3 --- tests/test_build_epub.py | 3 --- tests/test_build_gettext.py | 3 --- tests/test_build_html.py | 3 --- tests/test_build_latex.py | 3 --- tests/test_build_linkcheck.py | 3 --- tests/test_build_manpage.py | 3 --- tests/test_build_texinfo.py | 3 --- tests/test_build_text.py | 3 --- tests/test_builder.py | 3 --- tests/test_catalogs.py | 3 --- tests/test_config.py | 3 --- tests/test_correct_year.py | 3 --- tests/test_directive_code.py | 3 --- tests/test_directive_only.py | 3 --- tests/test_directive_other.py | 3 --- tests/test_directive_patch.py | 3 --- tests/test_docutilsconf.py | 3 --- tests/test_domain_c.py | 3 --- tests/test_domain_cpp.py | 3 --- tests/test_domain_js.py | 3 --- tests/test_domain_py.py | 3 --- tests/test_domain_rst.py | 3 --- tests/test_domain_std.py | 3 --- tests/test_environment.py | 3 --- tests/test_environment_indexentries.py | 3 --- tests/test_environment_toctree.py | 3 --- tests/test_events.py | 3 --- tests/test_ext_apidoc.py | 3 --- tests/test_ext_autodoc.py | 3 --- tests/test_ext_autodoc_autoattribute.py | 3 --- tests/test_ext_autodoc_autoclass.py | 3 --- tests/test_ext_autodoc_autodata.py | 3 --- tests/test_ext_autodoc_autofunction.py | 3 --- tests/test_ext_autodoc_automodule.py | 3 --- tests/test_ext_autodoc_autoproperty.py | 3 --- tests/test_ext_autodoc_configs.py | 3 --- tests/test_ext_autodoc_events.py | 3 --- tests/test_ext_autodoc_mock.py | 3 --- tests/test_ext_autodoc_preserve_defaults.py | 3 --- tests/test_ext_autodoc_private_members.py | 3 --- tests/test_ext_autosectionlabel.py | 3 --- tests/test_ext_autosummary.py | 3 --- tests/test_ext_coverage.py | 3 --- tests/test_ext_doctest.py | 3 --- tests/test_ext_duration.py | 3 --- tests/test_ext_githubpages.py | 3 --- tests/test_ext_graphviz.py | 3 --- tests/test_ext_ifconfig.py | 3 --- tests/test_ext_imgconverter.py | 3 --- tests/test_ext_inheritance_diagram.py | 3 --- tests/test_ext_intersphinx.py | 3 --- tests/test_ext_math.py | 3 --- tests/test_ext_napoleon.py | 3 --- tests/test_ext_napoleon_docstring.py | 3 --- tests/test_ext_napoleon_iterators.py | 3 --- tests/test_ext_todo.py | 3 --- tests/test_ext_viewcode.py | 3 --- tests/test_extension.py | 3 --- tests/test_highlighting.py | 3 --- tests/test_intl.py | 3 --- tests/test_locale.py | 3 --- tests/test_markup.py | 3 --- tests/test_metadata.py | 3 --- tests/test_parser.py | 3 --- tests/test_project.py | 3 --- tests/test_pycode.py | 3 --- tests/test_pycode_ast.py | 3 --- tests/test_pycode_parser.py | 3 --- tests/test_quickstart.py | 3 --- tests/test_roles.py | 3 --- tests/test_search.py | 3 --- tests/test_setup_command.py | 3 --- tests/test_smartquotes.py | 3 --- tests/test_templating.py | 3 --- tests/test_theming.py | 3 --- tests/test_toctree.py | 3 --- tests/test_transforms_post_transforms.py | 3 --- tests/test_transforms_post_transforms_code.py | 5 ----- tests/test_util.py | 3 --- tests/test_util_docstrings.py | 3 --- tests/test_util_docutils.py | 3 --- tests/test_util_fileutil.py | 3 --- tests/test_util_i18n.py | 3 --- tests/test_util_images.py | 3 --- tests/test_util_inspect.py | 3 --- tests/test_util_inventory.py | 3 --- tests/test_util_logging.py | 3 --- tests/test_util_matching.py | 3 --- tests/test_util_nodes.py | 3 --- tests/test_util_rst.py | 3 --- tests/test_util_template.py | 3 --- tests/test_util_typing.py | 3 --- tests/test_versioning.py | 3 --- tests/test_writer_latex.py | 3 --- utils/checks.py | 3 --- utils/doclinter.py | 3 --- utils/jssplitter_generator.py | 3 --- 279 files changed, 2 insertions(+), 854 deletions(-) diff --git a/sphinx/__init__.py b/sphinx/__init__.py index d8612c478..a77d4b147 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -1,7 +1,4 @@ """The Sphinx documentation toolchain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ # Keep this file executable as-is in Python 3! diff --git a/sphinx/__main__.py b/sphinx/__main__.py index adf352d83..5caff6510 100644 --- a/sphinx/__main__.py +++ b/sphinx/__main__.py @@ -1,7 +1,4 @@ """The Sphinx documentation toolchain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index d089fd5e4..88545c820 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -1,7 +1,4 @@ """Additional docutils nodes. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, List, Sequence diff --git a/sphinx/application.py b/sphinx/application.py index e6a743bd5..53bcc552a 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -1,9 +1,6 @@ """Sphinx application class and extensibility interface. Gracefully adapted from the TextPress system by Armin. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index f22524e1b..e99212dca 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -1,7 +1,4 @@ """Builder superclass for all builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pickle diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index ab8a8f42b..8dec8546f 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -1,7 +1,4 @@ """Base class of epub2/epub3 builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import html diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index 0351d0283..5230f1a24 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -1,7 +1,4 @@ """Changelog builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import html diff --git a/sphinx/builders/dirhtml.py b/sphinx/builders/dirhtml.py index e423d7f25..3397b9aaf 100644 --- a/sphinx/builders/dirhtml.py +++ b/sphinx/builders/dirhtml.py @@ -1,7 +1,4 @@ """Directory HTML builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/builders/dummy.py b/sphinx/builders/dummy.py index cb9b51902..ae8bfa32a 100644 --- a/sphinx/builders/dummy.py +++ b/sphinx/builders/dummy.py @@ -1,7 +1,4 @@ """Do syntax checks, but no writing. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Set diff --git a/sphinx/builders/epub3.py b/sphinx/builders/epub3.py index d172133ca..013955ed1 100644 --- a/sphinx/builders/epub3.py +++ b/sphinx/builders/epub3.py @@ -1,9 +1,6 @@ """Build epub3 files. Originally derived from epub.py. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import html diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index 20b61cdab..a8e9d25fd 100644 --- a/sphinx/builders/gettext.py +++ b/sphinx/builders/gettext.py @@ -1,7 +1,4 @@ """The MessageCatalogBuilder class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from codecs import open diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py index 13ef56956..006f06505 100644 --- a/sphinx/builders/html/__init__.py +++ b/sphinx/builders/html/__init__.py @@ -1,7 +1,4 @@ """Several HTML builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import html diff --git a/sphinx/builders/html/transforms.py b/sphinx/builders/html/transforms.py index b3670602d..74dd3c23d 100644 --- a/sphinx/builders/html/transforms.py +++ b/sphinx/builders/html/transforms.py @@ -1,7 +1,4 @@ """Transforms for HTML builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index e8a50bd3d..4ee9279a2 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -1,7 +1,4 @@ """LaTeX builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py index a32778e46..d208f9a60 100644 --- a/sphinx/builders/latex/constants.py +++ b/sphinx/builders/latex/constants.py @@ -1,7 +1,4 @@ """consntants for LaTeX builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict diff --git a/sphinx/builders/latex/nodes.py b/sphinx/builders/latex/nodes.py index 9432cfff9..adf0a0f63 100644 --- a/sphinx/builders/latex/nodes.py +++ b/sphinx/builders/latex/nodes.py @@ -1,7 +1,4 @@ """Additional nodes for LaTeX writer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from docutils import nodes diff --git a/sphinx/builders/latex/theming.py b/sphinx/builders/latex/theming.py index 3d0fa3b89..1f09ebd07 100644 --- a/sphinx/builders/latex/theming.py +++ b/sphinx/builders/latex/theming.py @@ -1,7 +1,4 @@ """Theming support for LaTeX builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import configparser diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py index f4ecf98b8..a4d6cc8e0 100644 --- a/sphinx/builders/latex/transforms.py +++ b/sphinx/builders/latex/transforms.py @@ -1,7 +1,4 @@ """Transforms for LaTeX builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, Set, Tuple, cast diff --git a/sphinx/builders/latex/util.py b/sphinx/builders/latex/util.py index 08f6b0fab..5419f2c1a 100644 --- a/sphinx/builders/latex/util.py +++ b/sphinx/builders/latex/util.py @@ -1,7 +1,4 @@ """Utilities for LaTeX builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Optional diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index 23712122e..d9d0cb3d7 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -1,7 +1,4 @@ """The CheckExternalLinksBuilder class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import json diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index cbd24ae05..04c154dce 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -1,7 +1,4 @@ """Manual pages builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py index f65deab3f..1a9b6a7eb 100644 --- a/sphinx/builders/singlehtml.py +++ b/sphinx/builders/singlehtml.py @@ -1,7 +1,4 @@ """Single HTML builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index a28939a93..6b42c4635 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -1,7 +1,4 @@ """Texinfo builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index b6dd4c343..8da91d462 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -1,7 +1,4 @@ """Plain-text Sphinx builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py index a466fa917..e16bbe36a 100644 --- a/sphinx/builders/xml.py +++ b/sphinx/builders/xml.py @@ -1,7 +1,4 @@ """Docutils-native XML and pseudo-XML builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/cmd/__init__.py b/sphinx/cmd/__init__.py index 7b22052c3..7b9ded4d3 100644 --- a/sphinx/cmd/__init__.py +++ b/sphinx/cmd/__init__.py @@ -1,5 +1,2 @@ """Modules for command line executables. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index 8605bfd7e..2df308b9e 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -1,7 +1,4 @@ """Build documentation from a provided source. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import argparse diff --git a/sphinx/cmd/make_mode.py b/sphinx/cmd/make_mode.py index 05945fb39..b8f3d33e1 100644 --- a/sphinx/cmd/make_mode.py +++ b/sphinx/cmd/make_mode.py @@ -5,9 +5,6 @@ of Makefile / make.bat. This is in its own module so that importing it is fast. It should not import the main Sphinx modules (like sphinx.applications, sphinx.builders). - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index 28b4d1618..6accb75d0 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -1,7 +1,4 @@ """Quickly setup documentation source to work with Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import argparse diff --git a/sphinx/config.py b/sphinx/config.py index 3b9eb61ba..ecbf7fa43 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -1,7 +1,4 @@ """Build configuration file handling. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py index f443b49d2..f08465d40 100644 --- a/sphinx/deprecation.py +++ b/sphinx/deprecation.py @@ -1,7 +1,4 @@ """Sphinx deprecation classes and utilities. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index 58230841e..a74717377 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -1,7 +1,4 @@ """Handlers for additional ReST directives. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/directives/code.py b/sphinx/directives/code.py index da5873711..dc44ed314 100644 --- a/sphinx/directives/code.py +++ b/sphinx/directives/code.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - import sys import textwrap from difflib import unified_diff diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index b2249719c..83cbb6707 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - import re from typing import TYPE_CHECKING, Any, Dict, List, cast diff --git a/sphinx/directives/patches.py b/sphinx/directives/patches.py index 5502028d0..a01d78332 100644 --- a/sphinx/directives/patches.py +++ b/sphinx/directives/patches.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - import os import warnings from os import path diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py index ef41a53fb..f422b8b74 100644 --- a/sphinx/domains/__init__.py +++ b/sphinx/domains/__init__.py @@ -2,9 +2,6 @@ Domains are groupings of description directives and roles describing e.g. constructs of one programming language. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import copy diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index e0ab20cb1..ade5c4a6f 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -1,7 +1,4 @@ """The C language domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index 6f9f9383d..e9891d480 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -1,7 +1,4 @@ """The changeset domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, cast diff --git a/sphinx/domains/citation.py b/sphinx/domains/citation.py index 53d56b205..e6043cc32 100644 --- a/sphinx/domains/citation.py +++ b/sphinx/domains/citation.py @@ -1,7 +1,4 @@ """The citation domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, cast diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 1918b3b6e..d504dc5bf 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1,7 +1,4 @@ """The C++ language domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/domains/index.py b/sphinx/domains/index.py index a82d27a69..81ffe36f5 100644 --- a/sphinx/domains/index.py +++ b/sphinx/domains/index.py @@ -1,7 +1,4 @@ """The index domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Tuple diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 40502456f..79dc3674f 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -1,7 +1,4 @@ """The JavaScript domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Iterator, List, Optional, Tuple, cast diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py index 0caecc858..ffece1f5d 100644 --- a/sphinx/domains/math.py +++ b/sphinx/domains/math.py @@ -1,7 +1,4 @@ """The math domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index ea7964417..28e61ff46 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -1,7 +1,4 @@ """The Python domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import builtins diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py index f7265e3c6..9d5d82de9 100644 --- a/sphinx/domains/rst.py +++ b/sphinx/domains/rst.py @@ -1,7 +1,4 @@ """The reStructuredText domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index 2f84ec7ce..50c872511 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -1,7 +1,4 @@ """The standard domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index 64d4b92db..ef7bcae15 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -1,7 +1,4 @@ """Global creation environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/environment/adapters/__init__.py b/sphinx/environment/adapters/__init__.py index 886b0c35a..03b8bde74 100644 --- a/sphinx/environment/adapters/__init__.py +++ b/sphinx/environment/adapters/__init__.py @@ -1,5 +1,2 @@ """Sphinx environment adapters - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ diff --git a/sphinx/environment/adapters/asset.py b/sphinx/environment/adapters/asset.py index 4a952eca7..29188b484 100644 --- a/sphinx/environment/adapters/asset.py +++ b/sphinx/environment/adapters/asset.py @@ -1,7 +1,4 @@ """Assets adapter for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from sphinx.environment import BuildEnvironment diff --git a/sphinx/environment/adapters/indexentries.py b/sphinx/environment/adapters/indexentries.py index af7f7b4b1..27a5f42b5 100644 --- a/sphinx/environment/adapters/indexentries.py +++ b/sphinx/environment/adapters/indexentries.py @@ -1,7 +1,4 @@ """Index entries adapters for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index ec766d491..72ce7e295 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/sphinx/environment/adapters/toctree.py @@ -1,7 +1,4 @@ """Toctree adapter for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Iterable, List, Optional, cast diff --git a/sphinx/environment/collectors/__init__.py b/sphinx/environment/collectors/__init__.py index db8c45c1b..1da2c9807 100644 --- a/sphinx/environment/collectors/__init__.py +++ b/sphinx/environment/collectors/__init__.py @@ -1,7 +1,4 @@ """The data collector components for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Dict, List, Optional, Set diff --git a/sphinx/environment/collectors/asset.py b/sphinx/environment/collectors/asset.py index 0c296900d..2cb78adf6 100644 --- a/sphinx/environment/collectors/asset.py +++ b/sphinx/environment/collectors/asset.py @@ -1,7 +1,4 @@ """The image collector for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/environment/collectors/dependencies.py b/sphinx/environment/collectors/dependencies.py index 7014600b4..6052ede5c 100644 --- a/sphinx/environment/collectors/dependencies.py +++ b/sphinx/environment/collectors/dependencies.py @@ -1,7 +1,4 @@ """The dependencies collector components for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/environment/collectors/metadata.py b/sphinx/environment/collectors/metadata.py index feb2e48dc..4075e8bc7 100644 --- a/sphinx/environment/collectors/metadata.py +++ b/sphinx/environment/collectors/metadata.py @@ -1,7 +1,4 @@ """The metadata collector components for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, Set, cast diff --git a/sphinx/environment/collectors/title.py b/sphinx/environment/collectors/title.py index 01385bda5..46e6e5937 100644 --- a/sphinx/environment/collectors/title.py +++ b/sphinx/environment/collectors/title.py @@ -1,7 +1,4 @@ """The title collector components for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Set diff --git a/sphinx/environment/collectors/toctree.py b/sphinx/environment/collectors/toctree.py index 2df4267e3..6656f3937 100644 --- a/sphinx/environment/collectors/toctree.py +++ b/sphinx/environment/collectors/toctree.py @@ -1,7 +1,4 @@ """Toctree collector for sphinx.environment. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, Set, Tuple, Type, TypeVar, cast diff --git a/sphinx/errors.py b/sphinx/errors.py index 7ac997d3a..c5f8ea2fe 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,7 +1,4 @@ """Contains SphinxError and a few subclasses. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any diff --git a/sphinx/events.py b/sphinx/events.py index 29d238964..5302cd005 100644 --- a/sphinx/events.py +++ b/sphinx/events.py @@ -1,9 +1,6 @@ """Sphinx core events. Gracefully adapted from the TextPress system by Armin. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from collections import defaultdict diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py index e17fe0dbd..635c4be59 100644 --- a/sphinx/ext/__init__.py +++ b/sphinx/ext/__init__.py @@ -1,5 +1,2 @@ """Contains Sphinx features not activated by default. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py index 378eca221..68afc83b8 100644 --- a/sphinx/ext/apidoc.py +++ b/sphinx/ext/apidoc.py @@ -7,9 +7,6 @@ creates a modules index (named modules.). This is derived from the "sphinx-autopackage" script, which is: Copyright 2008 Société des arts technologiques (SAT), https://sat.qc.ca/ - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import argparse diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 0b794bbb9..9bea15866 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -3,9 +3,6 @@ Automatically insert docstrings for functions, classes or whole modules into the doctree, thus avoiding duplication between docstrings and documentation for those who like elaborate docstrings. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/ext/autodoc/deprecated.py b/sphinx/ext/autodoc/deprecated.py index d4399c2c9..c20de236c 100644 --- a/sphinx/ext/autodoc/deprecated.py +++ b/sphinx/ext/autodoc/deprecated.py @@ -1,7 +1,4 @@ """The deprecated Documenters for autodoc. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import warnings diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index 3eeeba94f..2eb25536d 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - import warnings from typing import Any, Callable, Dict, List, Set, Type diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py index df5dd1b66..5d03c3f01 100644 --- a/sphinx/ext/autodoc/importer.py +++ b/sphinx/ext/autodoc/importer.py @@ -1,7 +1,4 @@ """Importer utilities for autodoc - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import importlib diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py index aa135e7b4..ae49b30f0 100644 --- a/sphinx/ext/autodoc/mock.py +++ b/sphinx/ext/autodoc/mock.py @@ -1,7 +1,4 @@ """mock for autodoc - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import contextlib diff --git a/sphinx/ext/autodoc/preserve_defaults.py b/sphinx/ext/autodoc/preserve_defaults.py index 5526ada6d..313fe5501 100644 --- a/sphinx/ext/autodoc/preserve_defaults.py +++ b/sphinx/ext/autodoc/preserve_defaults.py @@ -2,9 +2,6 @@ Preserve the default argument values of function signatures in source code and keep them not evaluated for readability. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import ast diff --git a/sphinx/ext/autodoc/type_comment.py b/sphinx/ext/autodoc/type_comment.py index 192e3c0c3..8578f282d 100644 --- a/sphinx/ext/autodoc/type_comment.py +++ b/sphinx/ext/autodoc/type_comment.py @@ -1,7 +1,4 @@ """Update annotations info of living objects using type_comments. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from inspect import Parameter, Signature, getsource diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py index 5532ade22..c9099198c 100644 --- a/sphinx/ext/autodoc/typehints.py +++ b/sphinx/ext/autodoc/typehints.py @@ -1,7 +1,4 @@ """Generating content for autodoc using typehints - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py index cfd976437..315a4d24b 100644 --- a/sphinx/ext/autosectionlabel.py +++ b/sphinx/ext/autosectionlabel.py @@ -1,7 +1,4 @@ """Allow reference sections by :ref: role using its title. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, cast diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index 5765300df..293803125 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -44,9 +44,6 @@ autolink role The autolink role functions as ``:obj:`` when the name referred can be resolved to a Python object, and otherwise it becomes simple emphasis. This can be used as the default role to make links 'smart'. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import inspect diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index 092efd13b..798c91e4c 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -10,9 +10,6 @@ Example Makefile rule:: generate: sphinx-autogen -o source/generated source/*.rst - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import argparse diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index 0cdbe80df..3ebd095c2 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -2,9 +2,6 @@ Mostly written by Josip Dzolonga for the Google Highly Open Participation contest. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import glob diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index 8a7b94a93..0c02547e9 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -1,9 +1,6 @@ """Mimic doctest in Sphinx. The extension automatically execute code snippets and checks their results. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import doctest diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py index eed1362f4..9be5d4d01 100644 --- a/sphinx/ext/duration.py +++ b/sphinx/ext/duration.py @@ -1,7 +1,4 @@ """Measure durations of Sphinx processing. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from datetime import datetime, timedelta diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py index 452c85034..4b476ec0a 100644 --- a/sphinx/ext/extlinks.py +++ b/sphinx/ext/extlinks.py @@ -15,9 +15,6 @@ the *caption* value given: You can also give an explicit caption, e.g. :exmpl:`Foo `. Both, the url string and the caption string must escape ``%`` as ``%%``. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py index e30756124..0f6f53cc3 100644 --- a/sphinx/ext/githubpages.py +++ b/sphinx/ext/githubpages.py @@ -1,7 +1,4 @@ """To publish HTML docs at GitHub Pages, create .nojekyll file. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index 0cb85a2b9..b4a69a0f2 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -1,7 +1,4 @@ """Allow graphviz-formatted graphs to be included inline in generated documents. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import posixpath diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 0d97a1189..bffaa49ff 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -12,9 +12,6 @@ Usage:: The argument for ``ifconfig`` is a plain Python expression, evaluated in the namespace of the project configuration (that is, all variables from ``conf.py`` are available.) - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index 40e3c2c18..47782c06c 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -1,7 +1,4 @@ """Image converter extension for Sphinx - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import subprocess diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index b95f3c71d..29e69f45c 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -1,7 +1,4 @@ """Render math in HTML via dvipng or dvisvgm. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import posixpath diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index 802f91b76..c8a3dc763 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -26,9 +26,6 @@ Example:: The graph is inserted as a PNG+image map into HTML and a PDF in LaTeX. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import builtins diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index 57802442a..64e296c39 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -14,9 +14,6 @@ This works as follows: rest of the documentation; however, the location of the mapping file can also be specified individually, e.g. if the docs should be buildable without Internet access. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import concurrent.futures diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index e6f3d24e4..38320ea7e 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -1,7 +1,4 @@ """Add external links to module code in Python object descriptions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Set diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index 6b4a2db13..d0d360e2e 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -3,9 +3,6 @@ This requires the MathJax JavaScript library on your webserver/computer. .. _MathJax: https://www.mathjax.org/ - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import json diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index 7f939a559..273e3a2dd 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -1,7 +1,4 @@ """Support for NumPy and Google style docstrings. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index 52256f5e9..c80baecba 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -2,9 +2,6 @@ Classes for docstring parsing and formatting. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import collections diff --git a/sphinx/ext/napoleon/iterators.py b/sphinx/ext/napoleon/iterators.py index 5a94fafd4..bebd56518 100644 --- a/sphinx/ext/napoleon/iterators.py +++ b/sphinx/ext/napoleon/iterators.py @@ -2,9 +2,6 @@ A collection of helpful iterators. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import collections diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index 3f27c6850..c0d034087 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -3,9 +3,6 @@ Inclusion of todos can be switched of by a configuration variable. The todolist directive collects all todos of your project and lists them along with a backlink to the original location. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, Tuple, cast diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 2c2dc6a39..4a96e9562 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -1,7 +1,4 @@ """Add links to module code in Python object descriptions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import posixpath diff --git a/sphinx/extension.py b/sphinx/extension.py index 0aeed6893..e11d75f8f 100644 --- a/sphinx/extension.py +++ b/sphinx/extension.py @@ -1,7 +1,4 @@ """Utilities for Sphinx extensions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index a729f7997..52fe098dc 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -1,7 +1,4 @@ """Highlight code blocks using Pygments. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from functools import partial diff --git a/sphinx/io.py b/sphinx/io.py index 5c0acb158..3d4be299f 100644 --- a/sphinx/io.py +++ b/sphinx/io.py @@ -1,7 +1,4 @@ """Input/Output files - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import codecs from typing import TYPE_CHECKING, Any, List, Type diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index e9a66105a..a38338d24 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -1,7 +1,4 @@ """Glue code for the jinja2 templating engine. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py index 19c4c9d3a..03f91b1f3 100644 --- a/sphinx/locale/__init__.py +++ b/sphinx/locale/__init__.py @@ -1,7 +1,4 @@ """Locale utilities. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import gettext diff --git a/sphinx/parsers.py b/sphinx/parsers.py index b5aa03f7b..2665d1265 100644 --- a/sphinx/parsers.py +++ b/sphinx/parsers.py @@ -1,7 +1,4 @@ """A Base class for additional parsers. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import warnings diff --git a/sphinx/project.py b/sphinx/project.py index a0956d07b..63d5819fd 100644 --- a/sphinx/project.py +++ b/sphinx/project.py @@ -1,7 +1,4 @@ """Utility function and classes for Sphinx projects. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index 6e7e5b751..96fba91a1 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -1,7 +1,4 @@ """Utilities parsing and analyzing Python code. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py index a8ac68c42..7f5e40d4d 100644 --- a/sphinx/pycode/ast.py +++ b/sphinx/pycode/ast.py @@ -1,7 +1,4 @@ """Helpers for AST (Abstract Syntax Tree). - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py index 4edab750a..303d7ae27 100644 --- a/sphinx/pycode/parser.py +++ b/sphinx/pycode/parser.py @@ -1,7 +1,4 @@ """Utilities parsing and analyzing Python code. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import inspect import itertools diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py index 73ee9d853..2d5e23c67 100644 --- a/sphinx/pygments_styles.py +++ b/sphinx/pygments_styles.py @@ -1,7 +1,4 @@ """Sphinx theme specific highlighting styles. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from pygments.style import Style diff --git a/sphinx/registry.py b/sphinx/registry.py index 3979a02eb..b51d07d3a 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -1,7 +1,4 @@ """Sphinx component registry. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import traceback diff --git a/sphinx/roles.py b/sphinx/roles.py index 2327cfee5..73d7feb0e 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -1,7 +1,4 @@ """Handlers for additional ReST roles. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index a4712f7d0..00e209603 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -1,7 +1,4 @@ """Create a full-text search index for offline search. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import html import pickle diff --git a/sphinx/search/da.py b/sphinx/search/da.py index 5aebf7790..5c3d138dd 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -1,7 +1,4 @@ """Danish search language: includes the JS Danish stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/de.py b/sphinx/search/de.py index 3c02669bf..8223f11f1 100644 --- a/sphinx/search/de.py +++ b/sphinx/search/de.py @@ -1,7 +1,4 @@ """German search language: includes the JS German stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/en.py b/sphinx/search/en.py index 49efabcd6..2f2f157e8 100644 --- a/sphinx/search/en.py +++ b/sphinx/search/en.py @@ -1,7 +1,4 @@ """English search language: includes the JS porter stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/es.py b/sphinx/search/es.py index f58c57f78..79e7e76d3 100644 --- a/sphinx/search/es.py +++ b/sphinx/search/es.py @@ -1,7 +1,4 @@ """Spanish search language: includes the JS Spanish stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py index e2685e672..9ca7f9d05 100644 --- a/sphinx/search/fi.py +++ b/sphinx/search/fi.py @@ -1,7 +1,4 @@ """Finnish search language: includes the JS Finnish stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py index 29bd71288..ad1ac547a 100644 --- a/sphinx/search/fr.py +++ b/sphinx/search/fr.py @@ -1,7 +1,4 @@ """French search language: includes the JS French stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py index 99f461077..46e8eae09 100644 --- a/sphinx/search/hu.py +++ b/sphinx/search/hu.py @@ -1,7 +1,4 @@ """Hungarian search language: includes the JS Hungarian stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/it.py b/sphinx/search/it.py index c5781cd48..c42e0ae54 100644 --- a/sphinx/search/it.py +++ b/sphinx/search/it.py @@ -1,7 +1,4 @@ """Italian search language: includes the JS Italian stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index a9093dbd1..5d18b702a 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -1,7 +1,4 @@ """Japanese search language: includes routine to split words. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ # Python Version of TinySegmenter diff --git a/sphinx/search/jssplitter.py b/sphinx/search/jssplitter.py index 82bb3951b..babdb8e47 100644 --- a/sphinx/search/jssplitter.py +++ b/sphinx/search/jssplitter.py @@ -1,9 +1,6 @@ """Provides Python compatible word splitter to JavaScript DO NOT EDIT. This is generated by utils/jssplitter_generator.py - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ splitter_code = """ diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py index dff5740fa..abb958fb9 100644 --- a/sphinx/search/nl.py +++ b/sphinx/search/nl.py @@ -1,7 +1,4 @@ """Dutch search language: includes the JS porter stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/no.py b/sphinx/search/no.py index 588d7b02d..67c338675 100644 --- a/sphinx/search/no.py +++ b/sphinx/search/no.py @@ -1,7 +1,4 @@ """Norwegian search language: includes the JS Norwegian stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py index d6bd43067..84408e795 100644 --- a/sphinx/search/pt.py +++ b/sphinx/search/pt.py @@ -1,7 +1,4 @@ """Portuguese search language: includes the JS Portuguese stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/ro.py b/sphinx/search/ro.py index caa32236e..46426f25e 100644 --- a/sphinx/search/ro.py +++ b/sphinx/search/ro.py @@ -1,7 +1,4 @@ """Romanian search language: includes the JS Romanian stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict, Set diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index 37234928a..778f18da6 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -1,7 +1,4 @@ """Russian search language: includes the JS Russian stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py index f352b30dd..b74d8980f 100644 --- a/sphinx/search/sv.py +++ b/sphinx/search/sv.py @@ -1,7 +1,4 @@ """Swedish search language: includes the JS Swedish stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict diff --git a/sphinx/search/tr.py b/sphinx/search/tr.py index d9b251308..1338c7116 100644 --- a/sphinx/search/tr.py +++ b/sphinx/search/tr.py @@ -1,7 +1,4 @@ """Turkish search language: includes the JS Turkish stemmer. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Dict, Set diff --git a/sphinx/search/zh.py b/sphinx/search/zh.py index 3ebf2317a..46f486bd3 100644 --- a/sphinx/search/zh.py +++ b/sphinx/search/zh.py @@ -1,7 +1,4 @@ """Chinese search language: includes routine to split words. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index d69a96011..19f2375c8 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -1,9 +1,6 @@ """Setuptools/distutils commands to assist the building of sphinx documentation. -:author: Sebastian Wiesner -:contact: basti.wiesner@gmx.net -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. +:author: Sebastian Wiesner """ import os diff --git a/sphinx/testing/__init__.py b/sphinx/testing/__init__.py index e219d2c3f..1cf074ff1 100644 --- a/sphinx/testing/__init__.py +++ b/sphinx/testing/__init__.py @@ -4,7 +4,4 @@ You can require sphinx.testing pytest fixtures in a test module or a conftest file like this: pytest_plugins = 'sphinx.testing.fixtures' - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ diff --git a/sphinx/testing/comparer.py b/sphinx/testing/comparer.py index c6ee44bfb..370bd264d 100644 --- a/sphinx/testing/comparer.py +++ b/sphinx/testing/comparer.py @@ -1,7 +1,4 @@ """Sphinx test comparer for pytest - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import difflib import pathlib diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py index c65986ba1..2f00ca974 100644 --- a/sphinx/testing/fixtures.py +++ b/sphinx/testing/fixtures.py @@ -1,7 +1,4 @@ """Sphinx test fixtures for pytest - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import subprocess diff --git a/sphinx/testing/path.py b/sphinx/testing/path.py index 021fb0425..404213ecc 100644 --- a/sphinx/testing/path.py +++ b/sphinx/testing/path.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - import builtins import os import shutil diff --git a/sphinx/testing/restructuredtext.py b/sphinx/testing/restructuredtext.py index 87b875a59..9deabb74a 100644 --- a/sphinx/testing/restructuredtext.py +++ b/sphinx/testing/restructuredtext.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - from os import path from docutils import nodes diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py index 904fdd221..bea449257 100644 --- a/sphinx/testing/util.py +++ b/sphinx/testing/util.py @@ -1,7 +1,4 @@ """Sphinx test suite utilities - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import functools import os diff --git a/sphinx/theming.py b/sphinx/theming.py index d77f4ff9c..3b662dd00 100644 --- a/sphinx/theming.py +++ b/sphinx/theming.py @@ -1,7 +1,4 @@ """Theming support for HTML builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import configparser diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py index f3cb13a70..3fa74c45b 100644 --- a/sphinx/transforms/__init__.py +++ b/sphinx/transforms/__init__.py @@ -1,7 +1,4 @@ """Docutils transforms used by Sphinx when reading documents. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py index ebbd303d4..b35df3cb1 100644 --- a/sphinx/transforms/compact_bullet_list.py +++ b/sphinx/transforms/compact_bullet_list.py @@ -1,7 +1,4 @@ """Docutils transforms used by Sphinx when reading documents. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, List, cast diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py index cc6250bf7..a45ec02d1 100644 --- a/sphinx/transforms/i18n.py +++ b/sphinx/transforms/i18n.py @@ -1,7 +1,4 @@ """Docutils transforms used by Sphinx when reading documents. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from os import path diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py index 63d3a7b1c..9b3c84edf 100644 --- a/sphinx/transforms/post_transforms/__init__.py +++ b/sphinx/transforms/post_transforms/__init__.py @@ -1,7 +1,4 @@ """Docutils transforms used by Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index 68be138dc..a47555bd1 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -1,7 +1,4 @@ """transforms for code-blocks. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py index 24d25f5b9..3f2c99b0f 100644 --- a/sphinx/transforms/post_transforms/images.py +++ b/sphinx/transforms/post_transforms/images.py @@ -1,7 +1,4 @@ """Docutils transforms used by Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py index 9b13c46df..da899f952 100644 --- a/sphinx/transforms/references.py +++ b/sphinx/transforms/references.py @@ -1,7 +1,4 @@ """Docutils transforms used by Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 517d79369..9dd30289a 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -1,7 +1,4 @@ """Utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import functools diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py index ec30f7987..8a45eabb2 100644 --- a/sphinx/util/build_phase.py +++ b/sphinx/util/build_phase.py @@ -1,7 +1,4 @@ """Build phase of Sphinx application. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from enum import IntEnum diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py index cfdcc7bec..c382a5634 100644 --- a/sphinx/util/cfamily.py +++ b/sphinx/util/cfamily.py @@ -1,7 +1,4 @@ """Utility functions common to the C and C++ domains. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 1432d117e..58ca9e1b0 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -1,7 +1,4 @@ """modules for backward compatibility - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/util/console.py b/sphinx/util/console.py index d844f21ee..22bb01514 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -1,7 +1,4 @@ """Format colored console output. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index 6617465da..7a2f802c5 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -2,9 +2,6 @@ "Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import TYPE_CHECKING, Any, Dict, List, Tuple, Type, Union, cast diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index 5112b7949..d952fa11b 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,7 +1,4 @@ """Utilities for docstring processing. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index bb6029376..07a17be79 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -1,7 +1,4 @@ """Utility functions for docutils. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py index e023e3871..c3ce9633c 100644 --- a/sphinx/util/fileutil.py +++ b/sphinx/util/fileutil.py @@ -1,7 +1,4 @@ """File utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py index 1ce5e562f..a7706e899 100644 --- a/sphinx/util/i18n.py +++ b/sphinx/util/i18n.py @@ -1,7 +1,4 @@ """Builder superclass for all builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/images.py b/sphinx/util/images.py index 838c61b64..a6d0918a0 100644 --- a/sphinx/util/images.py +++ b/sphinx/util/images.py @@ -1,7 +1,4 @@ """Image utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import base64 diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index aa5cb7bba..c9a4eb725 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -1,7 +1,4 @@ """Helpers for inspecting Python modules. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import builtins diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py index 08025cc80..d46a0916d 100644 --- a/sphinx/util/inventory.py +++ b/sphinx/util/inventory.py @@ -1,7 +1,4 @@ """Inventory utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os import re diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index 0a685a0ea..ed5aea4ba 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -1,9 +1,6 @@ """This module implements a simple JavaScript serializer. Uses the basestring encode function from simplejson by Bob Ippolito. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py index 38d06021b..3e1dad784 100644 --- a/sphinx/util/logging.py +++ b/sphinx/util/logging.py @@ -1,7 +1,4 @@ """Logging utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import logging diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index 14988a200..4aede2763 100644 --- a/sphinx/util/matching.py +++ b/sphinx/util/matching.py @@ -1,7 +1,4 @@ """Pattern-matching utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/math.py b/sphinx/util/math.py index d16051502..56523e10f 100644 --- a/sphinx/util/math.py +++ b/sphinx/util/math.py @@ -1,7 +1,4 @@ """Utility functions for math. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from docutils import nodes diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index 71888db1b..aff3d1875 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -1,7 +1,4 @@ """Docutils node-related utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index f3b78448e..7ce114aa0 100644 --- a/sphinx/util/osutil.py +++ b/sphinx/util/osutil.py @@ -1,7 +1,4 @@ """Operating system-related utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import contextlib diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index 4c093bb6f..39a5c741c 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -1,7 +1,4 @@ """Parallel building utilities. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/png.py b/sphinx/util/png.py index 20d13b0d8..0234ab9fd 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -1,7 +1,4 @@ """PNG image manipulation helpers. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import binascii diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index 431d5bb20..51f5af90d 100644 --- a/sphinx/util/pycompat.py +++ b/sphinx/util/pycompat.py @@ -1,7 +1,4 @@ """Stuff for Python version compatibility. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import warnings diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py index c625109fe..834274df2 100644 --- a/sphinx/util/requests.py +++ b/sphinx/util/requests.py @@ -1,7 +1,4 @@ """Simple requests package loader - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index 2b94b933a..aa9b335bc 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -1,7 +1,4 @@ """reST helper functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py index 4f38d81b7..16a8d7ac8 100644 --- a/sphinx/util/stemmer/__init__.py +++ b/sphinx/util/stemmer/__init__.py @@ -1,7 +1,4 @@ """Word stemming utilities for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from sphinx.util.stemmer.porter import PorterStemmer diff --git a/sphinx/util/stemmer/porter.py b/sphinx/util/stemmer/porter.py index 46983cbac..c4f89eb95 100644 --- a/sphinx/util/stemmer/porter.py +++ b/sphinx/util/stemmer/porter.py @@ -19,7 +19,7 @@ as exact as this version, even with the points of DEPARTURE! Release 1: January 2001 -:copyright: Copyright 2001 by Vivake Gupta . +:author: Vivake Gupta . :license: Public Domain ("can be used free of charge for any purpose"). """ diff --git a/sphinx/util/tags.py b/sphinx/util/tags.py index 5cbe5989a..89276732d 100644 --- a/sphinx/util/tags.py +++ b/sphinx/util/tags.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - from typing import Iterator, List from jinja2 import nodes diff --git a/sphinx/util/template.py b/sphinx/util/template.py index 8406aaecf..803fd4bad 100644 --- a/sphinx/util/template.py +++ b/sphinx/util/template.py @@ -1,7 +1,4 @@ """Templates utility functions for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index 758926df4..b25cb62c3 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -1,7 +1,4 @@ """TeX escaping helper. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py index 8935f4aa5..203205990 100644 --- a/sphinx/util/typing.py +++ b/sphinx/util/typing.py @@ -1,7 +1,4 @@ """The composite types for Sphinx. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/sphinx/versioning.py b/sphinx/versioning.py index b09590ffc..d34cf4df3 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -1,7 +1,4 @@ """Implements the low-level algorithms Sphinx uses for versioning doctrees. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pickle from itertools import product, zip_longest diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py index 3914bf67e..30487d18e 100644 --- a/sphinx/writers/__init__.py +++ b/sphinx/writers/__init__.py @@ -1,5 +1,2 @@ """Custom docutils writers. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index 123846609..d5b1ad30a 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -1,7 +1,4 @@ """docutils writers handling Sphinx' custom nodes. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index 752a2ef6b..bff8fcd09 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -1,7 +1,4 @@ """Experimental docutils writers for HTML5 handling Sphinx's custom nodes. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index fdf279418..1800a8bd3 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -2,9 +2,6 @@ Much of this code is adapted from Dave Kuhlman's "docpy" writer from his docutils sandbox. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index 9e484983a..7f97c52d3 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -1,7 +1,4 @@ """Manual page writer, extended for Sphinx custom nodes. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any, Dict, Iterable, cast diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index 5410d024a..5a14cab45 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -1,7 +1,4 @@ """Custom docutils writer for Texinfo. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index e2c49591e..7dc199354 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -1,7 +1,4 @@ """Custom docutils writer for plain text. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import math import os diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py index 29731d853..b3cd19edc 100644 --- a/sphinx/writers/xml.py +++ b/sphinx/writers/xml.py @@ -1,7 +1,4 @@ """Docutils-native XML and pseudo-XML writers. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any diff --git a/tests/conftest.py b/tests/conftest.py index 4a60dfc42..ebbc9e2c7 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - import os import shutil diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py index 9fc97abd7..d18d1eee2 100644 --- a/tests/test_api_translator.py +++ b/tests/test_api_translator.py @@ -1,7 +1,4 @@ """Test the Sphinx API for translator. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_application.py b/tests/test_application.py index de9593824..82dc88d74 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -1,7 +1,4 @@ """Test the Sphinx class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest.mock import Mock diff --git a/tests/test_build.py b/tests/test_build.py index 97898871a..8cb4da0e4 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -1,7 +1,4 @@ """Test all builders. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_build_changes.py b/tests/test_build_changes.py index 6312be1a2..d3ef56c5b 100644 --- a/tests/test_build_changes.py +++ b/tests/test_build_changes.py @@ -1,7 +1,4 @@ """Test the ChangesBuilder class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_build_dirhtml.py b/tests/test_build_dirhtml.py index d24ca68f2..ce16299a6 100644 --- a/tests/test_build_dirhtml.py +++ b/tests/test_build_dirhtml.py @@ -1,7 +1,4 @@ """Test dirhtml builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import posixpath diff --git a/tests/test_build_epub.py b/tests/test_build_epub.py index a0ecdeafd..820ac9727 100644 --- a/tests/test_build_epub.py +++ b/tests/test_build_epub.py @@ -1,7 +1,4 @@ """Test the HTML builder and check output against XPath. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index 1c753bd38..370efa777 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -1,7 +1,4 @@ """Test the build process with gettext builder with the test root. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import gettext diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 732ee994e..660d7f7ec 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -1,7 +1,4 @@ """Test the HTML builder and check output against XPath. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index a180be72b..7ac9bdcbb 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -1,7 +1,4 @@ """Test the build process with LaTeX builder with the test root. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py index 7170d244a..2c8d8f3eb 100644 --- a/tests/test_build_linkcheck.py +++ b/tests/test_build_linkcheck.py @@ -1,7 +1,4 @@ """Test the build process with manpage builder with the test root. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import http.server diff --git a/tests/test_build_manpage.py b/tests/test_build_manpage.py index cd28957ed..c890b4734 100644 --- a/tests/test_build_manpage.py +++ b/tests/test_build_manpage.py @@ -1,7 +1,4 @@ """Test the build process with manpage builder with the test root. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py index 840bba0bd..3dfb43c11 100644 --- a/tests/test_build_texinfo.py +++ b/tests/test_build_texinfo.py @@ -1,7 +1,4 @@ """Test the build process with Texinfo builder with the test root. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_build_text.py b/tests/test_build_text.py index 6d1365d0d..a8420d79e 100644 --- a/tests/test_build_text.py +++ b/tests/test_build_text.py @@ -1,7 +1,4 @@ """Test the build process with Text builder with the test root. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_builder.py b/tests/test_builder.py index cd321f5ee..c51e1203f 100644 --- a/tests/test_builder.py +++ b/tests/test_builder.py @@ -1,7 +1,4 @@ """Test the Builder class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_catalogs.py b/tests/test_catalogs.py index 5d2a06088..4e21bf0cb 100644 --- a/tests/test_catalogs.py +++ b/tests/test_catalogs.py @@ -1,7 +1,4 @@ """Test the base build process. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import shutil diff --git a/tests/test_config.py b/tests/test_config.py index 48b941b94..83aca3ae1 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -1,7 +1,4 @@ """Test the sphinx.config.Config class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest import mock diff --git a/tests/test_correct_year.py b/tests/test_correct_year.py index 9d66f934f..a672049b3 100644 --- a/tests/test_correct_year.py +++ b/tests/test_correct_year.py @@ -1,7 +1,4 @@ """Test copyright year adjustment - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_directive_code.py b/tests/test_directive_code.py index 371b3a6d6..824c304ff 100644 --- a/tests/test_directive_code.py +++ b/tests/test_directive_code.py @@ -1,7 +1,4 @@ """Test the code-block directive. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_directive_only.py b/tests/test_directive_only.py index 86a8afe04..e35fba580 100644 --- a/tests/test_directive_only.py +++ b/tests/test_directive_only.py @@ -1,7 +1,4 @@ """Test the only directive with the test root. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_directive_other.py b/tests/test_directive_other.py index b654f0356..e9bb147ed 100644 --- a/tests/test_directive_other.py +++ b/tests/test_directive_other.py @@ -1,7 +1,4 @@ """Test the other directives. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_directive_patch.py b/tests/test_directive_patch.py index 5e078829e..23877ae13 100644 --- a/tests/test_directive_patch.py +++ b/tests/test_directive_patch.py @@ -1,7 +1,4 @@ """Test the patched directives. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py index 8adb0dbd6..a18eb7043 100644 --- a/tests/test_docutilsconf.py +++ b/tests/test_docutilsconf.py @@ -1,7 +1,4 @@ """Test docutils.conf support for several writers. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_domain_c.py b/tests/test_domain_c.py index 90d1122a4..c3d14b239 100644 --- a/tests/test_domain_c.py +++ b/tests/test_domain_c.py @@ -1,7 +1,4 @@ """Tests the C Domain - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import itertools diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 565e91e23..f3b641414 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -1,7 +1,4 @@ """Tests the C++ Domain - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import itertools diff --git a/tests/test_domain_js.py b/tests/test_domain_js.py index baa8b31fa..773db4bb8 100644 --- a/tests/test_domain_js.py +++ b/tests/test_domain_js.py @@ -1,7 +1,4 @@ """Tests the JavaScript Domain - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest.mock import Mock diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py index f45fdc914..75d46a46f 100644 --- a/tests/test_domain_py.py +++ b/tests/test_domain_py.py @@ -1,7 +1,4 @@ """Tests the Python Domain - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_domain_rst.py b/tests/test_domain_rst.py index ed6dec79f..afe7ae8b8 100644 --- a/tests/test_domain_rst.py +++ b/tests/test_domain_rst.py @@ -1,7 +1,4 @@ """Tests the reStructuredText domain. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from sphinx import addnodes diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py index fa56e7fde..42c0e0ce0 100644 --- a/tests/test_domain_std.py +++ b/tests/test_domain_std.py @@ -1,7 +1,4 @@ """Tests the std domain - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest import mock diff --git a/tests/test_environment.py b/tests/test_environment.py index 2d289781a..e244d3841 100644 --- a/tests/test_environment.py +++ b/tests/test_environment.py @@ -1,7 +1,4 @@ """Test the BuildEnvironment class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os import shutil diff --git a/tests/test_environment_indexentries.py b/tests/test_environment_indexentries.py index a50506b9b..38fc3021e 100644 --- a/tests/test_environment_indexentries.py +++ b/tests/test_environment_indexentries.py @@ -1,7 +1,4 @@ """Test the sphinx.environment.managers.indexentries. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py index ca9f5e3b1..803519261 100644 --- a/tests/test_environment_toctree.py +++ b/tests/test_environment_toctree.py @@ -1,7 +1,4 @@ """Test the sphinx.environment.managers.toctree. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_events.py b/tests/test_events.py index 7cd6bccd0..44d80f1c0 100644 --- a/tests/test_events.py +++ b/tests/test_events.py @@ -1,7 +1,4 @@ """Test the EventManager class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py index b31f64dc7..c58882c6e 100644 --- a/tests/test_ext_apidoc.py +++ b/tests/test_ext_apidoc.py @@ -1,7 +1,4 @@ """Test the sphinx.apidoc module. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from collections import namedtuple diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py index 60eb3b925..3cbfe2eea 100644 --- a/tests/test_ext_autodoc.py +++ b/tests/test_ext_autodoc.py @@ -2,9 +2,6 @@ This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autoattribute.py b/tests/test_ext_autodoc_autoattribute.py index 692f06f6d..ec48f08b3 100644 --- a/tests/test_ext_autodoc_autoattribute.py +++ b/tests/test_ext_autodoc_autoattribute.py @@ -2,9 +2,6 @@ This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autoclass.py b/tests/test_ext_autodoc_autoclass.py index 064f8136f..508e63782 100644 --- a/tests/test_ext_autodoc_autoclass.py +++ b/tests/test_ext_autodoc_autoclass.py @@ -2,9 +2,6 @@ This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autodata.py b/tests/test_ext_autodoc_autodata.py index 709797ff7..e8c14d27a 100644 --- a/tests/test_ext_autodoc_autodata.py +++ b/tests/test_ext_autodoc_autodata.py @@ -2,9 +2,6 @@ This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autofunction.py b/tests/test_ext_autodoc_autofunction.py index 60b8bf89c..55a308300 100644 --- a/tests/test_ext_autodoc_autofunction.py +++ b/tests/test_ext_autodoc_autofunction.py @@ -2,9 +2,6 @@ This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_autodoc_automodule.py b/tests/test_ext_autodoc_automodule.py index 6333ba5c0..6b356e584 100644 --- a/tests/test_ext_autodoc_automodule.py +++ b/tests/test_ext_autodoc_automodule.py @@ -2,9 +2,6 @@ This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_autoproperty.py b/tests/test_ext_autodoc_autoproperty.py index 765ba30ac..3d50020b3 100644 --- a/tests/test_ext_autodoc_autoproperty.py +++ b/tests/test_ext_autodoc_autoproperty.py @@ -2,9 +2,6 @@ This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_configs.py b/tests/test_ext_autodoc_configs.py index 46bd9e767..3ed2fc38b 100644 --- a/tests/test_ext_autodoc_configs.py +++ b/tests/test_ext_autodoc_configs.py @@ -1,7 +1,4 @@ """Test the autodoc extension. This tests mainly for config variables - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import platform diff --git a/tests/test_ext_autodoc_events.py b/tests/test_ext_autodoc_events.py index d7c69c258..bde25cd37 100644 --- a/tests/test_ext_autodoc_events.py +++ b/tests/test_ext_autodoc_events.py @@ -1,7 +1,4 @@ """Test the autodoc extension. This tests mainly for autodoc events - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_autodoc_mock.py b/tests/test_ext_autodoc_mock.py index 51c8bedda..43493959f 100644 --- a/tests/test_ext_autodoc_mock.py +++ b/tests/test_ext_autodoc_mock.py @@ -1,7 +1,4 @@ """Test the autodoc extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import abc diff --git a/tests/test_ext_autodoc_preserve_defaults.py b/tests/test_ext_autodoc_preserve_defaults.py index 56bea8fbc..bb239a2bb 100644 --- a/tests/test_ext_autodoc_preserve_defaults.py +++ b/tests/test_ext_autodoc_preserve_defaults.py @@ -1,7 +1,4 @@ """Test the autodoc extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_autodoc_private_members.py b/tests/test_ext_autodoc_private_members.py index beb0ec373..bdb947821 100644 --- a/tests/test_ext_autodoc_private_members.py +++ b/tests/test_ext_autodoc_private_members.py @@ -1,7 +1,4 @@ """Test the autodoc extension. This tests mainly for private-members option. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_autosectionlabel.py b/tests/test_ext_autosectionlabel.py index f81031d4b..4aaf010bb 100644 --- a/tests/test_ext_autosectionlabel.py +++ b/tests/test_ext_autosectionlabel.py @@ -1,7 +1,4 @@ """Test sphinx.ext.autosectionlabel extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py index 53aaf95ef..26909080d 100644 --- a/tests/test_ext_autosummary.py +++ b/tests/test_ext_autosummary.py @@ -1,7 +1,4 @@ """Test the autosummary extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_coverage.py b/tests/test_ext_coverage.py index 0597b12d7..803e234e2 100644 --- a/tests/test_ext_coverage.py +++ b/tests/test_ext_coverage.py @@ -1,7 +1,4 @@ """Test the coverage builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pickle diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index 1bd86919a..6cfff441f 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -1,7 +1,4 @@ """Test the doctest extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os from collections import Counter diff --git a/tests/test_ext_duration.py b/tests/test_ext_duration.py index 5b459fbec..05f3ef422 100644 --- a/tests/test_ext_duration.py +++ b/tests/test_ext_duration.py @@ -1,7 +1,4 @@ """Test sphinx.ext.duration extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_githubpages.py b/tests/test_ext_githubpages.py index 8067a5b98..7f60d7492 100644 --- a/tests/test_ext_githubpages.py +++ b/tests/test_ext_githubpages.py @@ -1,7 +1,4 @@ """Test sphinx.ext.githubpages extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py index 0d6f1de6d..c6a688bb5 100644 --- a/tests/test_ext_graphviz.py +++ b/tests/test_ext_graphviz.py @@ -1,7 +1,4 @@ """Test sphinx.ext.graphviz extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_ifconfig.py b/tests/test_ext_ifconfig.py index 3de09e367..1a6625026 100644 --- a/tests/test_ext_ifconfig.py +++ b/tests/test_ext_ifconfig.py @@ -1,7 +1,4 @@ """Test sphinx.ext.ifconfig extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_ext_imgconverter.py b/tests/test_ext_imgconverter.py index d8a152e8b..8fee95746 100644 --- a/tests/test_ext_imgconverter.py +++ b/tests/test_ext_imgconverter.py @@ -1,7 +1,4 @@ """Test sphinx.ext.imgconverter extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py index 5b8ccdaff..db7944218 100644 --- a/tests/test_ext_inheritance_diagram.py +++ b/tests/test_ext_inheritance_diagram.py @@ -1,7 +1,4 @@ """Test sphinx.ext.inheritance_diagram extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py index 08525d889..8e45890aa 100644 --- a/tests/test_ext_intersphinx.py +++ b/tests/test_ext_intersphinx.py @@ -1,7 +1,4 @@ """Test the intersphinx extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import http.server diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index b293ca98e..b251e41d2 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -1,7 +1,4 @@ """Test math extensions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_napoleon.py b/tests/test_ext_napoleon.py index 9f51ccfd5..bcc0d6d23 100644 --- a/tests/test_ext_napoleon.py +++ b/tests/test_ext_napoleon.py @@ -1,8 +1,5 @@ """Tests for :mod:`sphinx.ext.napoleon.__init__` module. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index 314c12dec..514276061 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -1,8 +1,5 @@ """Tests for :mod:`sphinx.ext.napoleon.docstring` module. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_napoleon_iterators.py b/tests/test_ext_napoleon_iterators.py index c3b07895c..e9684521e 100644 --- a/tests/test_ext_napoleon_iterators.py +++ b/tests/test_ext_napoleon_iterators.py @@ -1,8 +1,5 @@ """Tests for :mod:`sphinx.ext.napoleon.iterators` module. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest import TestCase diff --git a/tests/test_ext_todo.py b/tests/test_ext_todo.py index f16fddd55..15ecc1bed 100644 --- a/tests/test_ext_todo.py +++ b/tests/test_ext_todo.py @@ -1,7 +1,4 @@ """Test sphinx.ext.todo extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py index 44c2efbf3..11aacfc43 100644 --- a/tests/test_ext_viewcode.py +++ b/tests/test_ext_viewcode.py @@ -1,7 +1,4 @@ """Test sphinx.ext.viewcode extension. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_extension.py b/tests/test_extension.py index 1a6993fc5..d2cd37567 100644 --- a/tests/test_extension.py +++ b/tests/test_extension.py @@ -1,7 +1,4 @@ """Test sphinx.extension module. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index 59a38f4fe..dc23116a7 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -1,7 +1,4 @@ """Test the Pygments highlighting bridge. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest import mock diff --git a/tests/test_intl.py b/tests/test_intl.py index b125a0d17..44740f67d 100644 --- a/tests/test_intl.py +++ b/tests/test_intl.py @@ -1,9 +1,6 @@ """Test message patching for internationalization purposes. Runs the text builder in the test root. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_locale.py b/tests/test_locale.py index 909ce3480..99a335cff 100644 --- a/tests/test_locale.py +++ b/tests/test_locale.py @@ -1,7 +1,4 @@ """Test locale. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_markup.py b/tests/test_markup.py index a0e6e4d59..030323e90 100644 --- a/tests/test_markup.py +++ b/tests/test_markup.py @@ -1,7 +1,4 @@ """Test various Sphinx-specific markup extensions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_metadata.py b/tests/test_metadata.py index df77c0320..7cc0aa3c7 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1,7 +1,4 @@ """Test our handling of metadata in files with bibliographic metadata. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ # adapted from an example of bibliographic metadata at diff --git a/tests/test_parser.py b/tests/test_parser.py index 473048ce6..2c9462936 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -1,7 +1,4 @@ """Tests parsers module. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest.mock import Mock, patch diff --git a/tests/test_project.py b/tests/test_project.py index 0d962e84a..1f4c4709f 100644 --- a/tests/test_project.py +++ b/tests/test_project.py @@ -1,7 +1,4 @@ """Tests project module. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from collections import OrderedDict diff --git a/tests/test_pycode.py b/tests/test_pycode.py index 3c132aaee..560dbc8a2 100644 --- a/tests/test_pycode.py +++ b/tests/test_pycode.py @@ -1,7 +1,4 @@ """Test pycode. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_pycode_ast.py b/tests/test_pycode_ast.py index 68c03dc2f..c3e256338 100644 --- a/tests/test_pycode_ast.py +++ b/tests/test_pycode_ast.py @@ -1,7 +1,4 @@ """Test pycode.ast - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_pycode_parser.py b/tests/test_pycode_parser.py index 3ad1486da..cebcb97a3 100644 --- a/tests/test_pycode_parser.py +++ b/tests/test_pycode_parser.py @@ -1,7 +1,4 @@ """Test pycode.parser. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from sphinx.pycode.parser import Parser diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py index e2c5af3aa..4b79ee131 100644 --- a/tests/test_quickstart.py +++ b/tests/test_quickstart.py @@ -1,7 +1,4 @@ """Test the sphinx.quickstart module. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import time diff --git a/tests/test_roles.py b/tests/test_roles.py index e29df9e7f..70762f48e 100644 --- a/tests/test_roles.py +++ b/tests/test_roles.py @@ -1,7 +1,4 @@ """Test sphinx.roles - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest.mock import Mock diff --git a/tests/test_search.py b/tests/test_search.py index 7957a2b11..0568afa8f 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -1,7 +1,4 @@ """Test the search index builder. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from collections import namedtuple diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py index 18a2ae368..95c4ae201 100644 --- a/tests/test_setup_command.py +++ b/tests/test_setup_command.py @@ -1,7 +1,4 @@ """Test setup_command for distutils. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_smartquotes.py b/tests/test_smartquotes.py index eb70c4058..6233a38e4 100644 --- a/tests/test_smartquotes.py +++ b/tests/test_smartquotes.py @@ -1,7 +1,4 @@ """Test smart quotes. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_templating.py b/tests/test_templating.py index 5be71e07b..4f1ef64ee 100644 --- a/tests/test_templating.py +++ b/tests/test_templating.py @@ -1,7 +1,4 @@ """Test templating. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_theming.py b/tests/test_theming.py index 557ea0a93..11173fd9b 100644 --- a/tests/test_theming.py +++ b/tests/test_theming.py @@ -1,7 +1,4 @@ """Test the Theme class. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_toctree.py b/tests/test_toctree.py index 60c343547..e4d77051f 100644 --- a/tests/test_toctree.py +++ b/tests/test_toctree.py @@ -1,7 +1,4 @@ """Test the HTML builder and check output against XPath. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import re diff --git a/tests/test_transforms_post_transforms.py b/tests/test_transforms_post_transforms.py index fa5c063e7..6534dd9b4 100644 --- a/tests/test_transforms_post_transforms.py +++ b/tests/test_transforms_post_transforms.py @@ -1,7 +1,4 @@ """Tests the post_transforms - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_transforms_post_transforms_code.py b/tests/test_transforms_post_transforms_code.py index 0029fbead..2715eb5a5 100644 --- a/tests/test_transforms_post_transforms_code.py +++ b/tests/test_transforms_post_transforms_code.py @@ -1,8 +1,3 @@ -""" -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. -""" - import pytest diff --git a/tests/test_util.py b/tests/test_util.py index 470f365d8..c676113f8 100644 --- a/tests/test_util.py +++ b/tests/test_util.py @@ -1,7 +1,4 @@ """Tests util functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_util_docstrings.py b/tests/test_util_docstrings.py index af09a8cbe..05e7b7523 100644 --- a/tests/test_util_docstrings.py +++ b/tests/test_util_docstrings.py @@ -1,7 +1,4 @@ """Test sphinx.util.docstrings. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from sphinx.util.docstrings import prepare_commentdoc, prepare_docstring, separate_metadata diff --git a/tests/test_util_docutils.py b/tests/test_util_docutils.py index 2d9c805b7..d6f97909d 100644 --- a/tests/test_util_docutils.py +++ b/tests/test_util_docutils.py @@ -1,7 +1,4 @@ """Tests util.utils functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_util_fileutil.py b/tests/test_util_fileutil.py index 52f189bfe..11a5a8557 100644 --- a/tests/test_util_fileutil.py +++ b/tests/test_util_fileutil.py @@ -1,7 +1,4 @@ """Tests sphinx.util.fileutil functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from unittest import mock diff --git a/tests/test_util_i18n.py b/tests/test_util_i18n.py index bf5913dbd..ee9a640ef 100644 --- a/tests/test_util_i18n.py +++ b/tests/test_util_i18n.py @@ -1,7 +1,4 @@ """Test i18n util. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import datetime diff --git a/tests/test_util_images.py b/tests/test_util_images.py index 43a2e2597..dd0648a83 100644 --- a/tests/test_util_images.py +++ b/tests/test_util_images.py @@ -1,7 +1,4 @@ """Test images util. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 8eaaba38f..3987beb24 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -1,7 +1,4 @@ """Tests util.inspect functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import ast diff --git a/tests/test_util_inventory.py b/tests/test_util_inventory.py index 9189485a2..ce96085e3 100644 --- a/tests/test_util_inventory.py +++ b/tests/test_util_inventory.py @@ -1,7 +1,4 @@ """Test inventory util functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import posixpath diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py index 4a1366bc0..0c2b914b0 100644 --- a/tests/test_util_logging.py +++ b/tests/test_util_logging.py @@ -1,7 +1,4 @@ """Test logging util. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import codecs diff --git a/tests/test_util_matching.py b/tests/test_util_matching.py index bb5896fa0..559fa7aff 100644 --- a/tests/test_util_matching.py +++ b/tests/test_util_matching.py @@ -1,7 +1,4 @@ """Tests sphinx.util.matching functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from sphinx.util.matching import Matcher, compile_matchers diff --git a/tests/test_util_nodes.py b/tests/test_util_nodes.py index 4f404fb4c..d73929b9c 100644 --- a/tests/test_util_nodes.py +++ b/tests/test_util_nodes.py @@ -1,7 +1,4 @@ """Tests uti.nodes functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from textwrap import dedent from typing import Any diff --git a/tests/test_util_rst.py b/tests/test_util_rst.py index e2c87cf2e..61012e0af 100644 --- a/tests/test_util_rst.py +++ b/tests/test_util_rst.py @@ -1,7 +1,4 @@ """Tests sphinx.util.rst functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from docutils.statemachine import StringList diff --git a/tests/test_util_template.py b/tests/test_util_template.py index b49d44dfd..c2f896968 100644 --- a/tests/test_util_template.py +++ b/tests/test_util_template.py @@ -1,7 +1,4 @@ """Tests sphinx.util.template functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from sphinx.util.template import ReSTRenderer diff --git a/tests/test_util_typing.py b/tests/test_util_typing.py index 1a7bbb054..cf6ef0ebf 100644 --- a/tests/test_util_typing.py +++ b/tests/test_util_typing.py @@ -1,7 +1,4 @@ """Tests util.typing functions. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_versioning.py b/tests/test_versioning.py index b41a3f07b..e32290aad 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -1,7 +1,4 @@ """Test the versioning implementation. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pickle diff --git a/tests/test_writer_latex.py b/tests/test_writer_latex.py index cd2052719..f68694e4e 100644 --- a/tests/test_writer_latex.py +++ b/tests/test_writer_latex.py @@ -1,7 +1,4 @@ """Test the LaTeX writer - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import pytest diff --git a/utils/checks.py b/utils/checks.py index 952ab8afd..aa1f2f206 100644 --- a/utils/checks.py +++ b/utils/checks.py @@ -1,7 +1,4 @@ """Custom, Sphinx-only flake8 plugins. - -:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/utils/doclinter.py b/utils/doclinter.py index 7b3c2f91d..544f9952b 100644 --- a/utils/doclinter.py +++ b/utils/doclinter.py @@ -1,7 +1,4 @@ """A linter for Sphinx docs - -:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ import os diff --git a/utils/jssplitter_generator.py b/utils/jssplitter_generator.py index 0f2f3759a..f0918ec3f 100644 --- a/utils/jssplitter_generator.py +++ b/utils/jssplitter_generator.py @@ -115,9 +115,6 @@ python_src = '''\ """Provides Python compatible word splitter to JavaScript DO NOT EDIT. This is generated by utils/jssplitter_generator.py - -:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ splitter_code = """ From 5775912455c25ee82734e1ff319a32f55946d79b Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 03:05:56 +0000 Subject: [PATCH 6/9] Collapse single line docstrings --- sphinx/__init__.py | 3 +-- sphinx/__main__.py | 3 +-- sphinx/addnodes.py | 3 +-- sphinx/builders/__init__.py | 3 +-- sphinx/builders/_epub_base.py | 3 +-- sphinx/builders/changes.py | 3 +-- sphinx/builders/dirhtml.py | 3 +-- sphinx/builders/dummy.py | 3 +-- sphinx/builders/gettext.py | 3 +-- sphinx/builders/html/__init__.py | 3 +-- sphinx/builders/html/transforms.py | 3 +-- sphinx/builders/latex/__init__.py | 3 +-- sphinx/builders/latex/constants.py | 3 +-- sphinx/builders/latex/nodes.py | 3 +-- sphinx/builders/latex/theming.py | 3 +-- sphinx/builders/latex/transforms.py | 3 +-- sphinx/builders/latex/util.py | 3 +-- sphinx/builders/linkcheck.py | 3 +-- sphinx/builders/manpage.py | 3 +-- sphinx/builders/singlehtml.py | 3 +-- sphinx/builders/texinfo.py | 3 +-- sphinx/builders/text.py | 3 +-- sphinx/builders/xml.py | 3 +-- sphinx/cmd/__init__.py | 3 +-- sphinx/cmd/build.py | 3 +-- sphinx/cmd/quickstart.py | 3 +-- sphinx/config.py | 3 +-- sphinx/deprecation.py | 3 +-- sphinx/directives/__init__.py | 3 +-- sphinx/domains/c.py | 3 +-- sphinx/domains/changeset.py | 3 +-- sphinx/domains/citation.py | 3 +-- sphinx/domains/cpp.py | 3 +-- sphinx/domains/index.py | 3 +-- sphinx/domains/javascript.py | 3 +-- sphinx/domains/math.py | 3 +-- sphinx/domains/python.py | 3 +-- sphinx/domains/rst.py | 3 +-- sphinx/domains/std.py | 3 +-- sphinx/environment/__init__.py | 3 +-- sphinx/environment/adapters/__init__.py | 3 +-- sphinx/environment/adapters/asset.py | 3 +-- sphinx/environment/adapters/indexentries.py | 3 +-- sphinx/environment/adapters/toctree.py | 3 +-- sphinx/environment/collectors/__init__.py | 3 +-- sphinx/environment/collectors/asset.py | 3 +-- sphinx/environment/collectors/dependencies.py | 3 +-- sphinx/environment/collectors/metadata.py | 3 +-- sphinx/environment/collectors/title.py | 3 +-- sphinx/environment/collectors/toctree.py | 3 +-- sphinx/errors.py | 3 +-- sphinx/ext/__init__.py | 3 +-- sphinx/ext/autodoc/deprecated.py | 3 +-- sphinx/ext/autodoc/importer.py | 3 +-- sphinx/ext/autodoc/mock.py | 3 +-- sphinx/ext/autodoc/type_comment.py | 3 +-- sphinx/ext/autodoc/typehints.py | 3 +-- sphinx/ext/autosectionlabel.py | 3 +-- sphinx/ext/duration.py | 3 +-- sphinx/ext/githubpages.py | 3 +-- sphinx/ext/imgconverter.py | 3 +-- sphinx/ext/imgmath.py | 3 +-- sphinx/ext/linkcode.py | 3 +-- sphinx/ext/napoleon/__init__.py | 3 +-- sphinx/ext/viewcode.py | 3 +-- sphinx/extension.py | 3 +-- sphinx/highlighting.py | 3 +-- sphinx/io.py | 3 +-- sphinx/jinja2glue.py | 3 +-- sphinx/locale/__init__.py | 3 +-- sphinx/parsers.py | 3 +-- sphinx/project.py | 3 +-- sphinx/pycode/__init__.py | 3 +-- sphinx/pycode/ast.py | 3 +-- sphinx/pycode/parser.py | 3 +-- sphinx/pygments_styles.py | 3 +-- sphinx/registry.py | 3 +-- sphinx/roles.py | 3 +-- sphinx/search/__init__.py | 3 +-- sphinx/search/da.py | 3 +-- sphinx/search/de.py | 3 +-- sphinx/search/en.py | 3 +-- sphinx/search/es.py | 3 +-- sphinx/search/fi.py | 3 +-- sphinx/search/fr.py | 3 +-- sphinx/search/hu.py | 3 +-- sphinx/search/it.py | 3 +-- sphinx/search/ja.py | 3 +-- sphinx/search/nl.py | 3 +-- sphinx/search/no.py | 3 +-- sphinx/search/pt.py | 3 +-- sphinx/search/ro.py | 3 +-- sphinx/search/ru.py | 3 +-- sphinx/search/sv.py | 3 +-- sphinx/search/tr.py | 3 +-- sphinx/search/zh.py | 3 +-- sphinx/testing/comparer.py | 3 +-- sphinx/testing/fixtures.py | 3 +-- sphinx/testing/util.py | 3 +-- sphinx/theming.py | 3 +-- sphinx/transforms/__init__.py | 3 +-- sphinx/transforms/compact_bullet_list.py | 3 +-- sphinx/transforms/i18n.py | 3 +-- sphinx/transforms/post_transforms/__init__.py | 3 +-- sphinx/transforms/post_transforms/code.py | 3 +-- sphinx/transforms/post_transforms/images.py | 3 +-- sphinx/transforms/references.py | 3 +-- sphinx/util/__init__.py | 3 +-- sphinx/util/build_phase.py | 3 +-- sphinx/util/cfamily.py | 3 +-- sphinx/util/compat.py | 3 +-- sphinx/util/console.py | 3 +-- sphinx/util/docstrings.py | 3 +-- sphinx/util/docutils.py | 3 +-- sphinx/util/fileutil.py | 3 +-- sphinx/util/i18n.py | 3 +-- sphinx/util/images.py | 3 +-- sphinx/util/inspect.py | 3 +-- sphinx/util/inventory.py | 3 +-- sphinx/util/logging.py | 3 +-- sphinx/util/matching.py | 3 +-- sphinx/util/math.py | 3 +-- sphinx/util/nodes.py | 3 +-- sphinx/util/osutil.py | 3 +-- sphinx/util/parallel.py | 3 +-- sphinx/util/png.py | 3 +-- sphinx/util/pycompat.py | 3 +-- sphinx/util/requests.py | 3 +-- sphinx/util/rst.py | 3 +-- sphinx/util/stemmer/__init__.py | 3 +-- sphinx/util/template.py | 3 +-- sphinx/util/texescape.py | 3 +-- sphinx/util/typing.py | 3 +-- sphinx/versioning.py | 3 +-- sphinx/writers/__init__.py | 3 +-- sphinx/writers/html.py | 3 +-- sphinx/writers/html5.py | 3 +-- sphinx/writers/manpage.py | 3 +-- sphinx/writers/texinfo.py | 3 +-- sphinx/writers/text.py | 3 +-- sphinx/writers/xml.py | 3 +-- tests/ext_napoleon_pep526_data_google.py | 3 +-- tests/ext_napoleon_pep526_data_numpy.py | 3 +-- tests/test_api_translator.py | 3 +-- tests/test_application.py | 3 +-- tests/test_build.py | 3 +-- tests/test_build_changes.py | 3 +-- tests/test_build_dirhtml.py | 3 +-- tests/test_build_epub.py | 3 +-- tests/test_build_gettext.py | 3 +-- tests/test_build_html.py | 3 +-- tests/test_build_latex.py | 3 +-- tests/test_build_linkcheck.py | 3 +-- tests/test_build_manpage.py | 3 +-- tests/test_build_texinfo.py | 3 +-- tests/test_build_text.py | 3 +-- tests/test_builder.py | 3 +-- tests/test_catalogs.py | 3 +-- tests/test_config.py | 3 +-- tests/test_correct_year.py | 3 +-- tests/test_directive_code.py | 3 +-- tests/test_directive_only.py | 3 +-- tests/test_directive_other.py | 3 +-- tests/test_directive_patch.py | 3 +-- tests/test_docutilsconf.py | 3 +-- tests/test_domain_c.py | 3 +-- tests/test_domain_cpp.py | 3 +-- tests/test_domain_js.py | 3 +-- tests/test_domain_py.py | 3 +-- tests/test_domain_rst.py | 3 +-- tests/test_domain_std.py | 3 +-- tests/test_environment.py | 3 +-- tests/test_environment_indexentries.py | 3 +-- tests/test_environment_toctree.py | 3 +-- tests/test_events.py | 3 +-- tests/test_ext_apidoc.py | 3 +-- tests/test_ext_autodoc_configs.py | 3 +-- tests/test_ext_autodoc_events.py | 3 +-- tests/test_ext_autodoc_mock.py | 3 +-- tests/test_ext_autodoc_preserve_defaults.py | 3 +-- tests/test_ext_autosectionlabel.py | 3 +-- tests/test_ext_autosummary.py | 3 +-- tests/test_ext_coverage.py | 3 +-- tests/test_ext_doctest.py | 3 +-- tests/test_ext_duration.py | 3 +-- tests/test_ext_githubpages.py | 3 +-- tests/test_ext_graphviz.py | 3 +-- tests/test_ext_ifconfig.py | 3 +-- tests/test_ext_imgconverter.py | 3 +-- tests/test_ext_inheritance_diagram.py | 3 +-- tests/test_ext_intersphinx.py | 3 +-- tests/test_ext_math.py | 3 +-- tests/test_ext_todo.py | 3 +-- tests/test_ext_viewcode.py | 3 +-- tests/test_extension.py | 3 +-- tests/test_highlighting.py | 3 +-- tests/test_locale.py | 3 +-- tests/test_markup.py | 3 +-- tests/test_metadata.py | 3 +-- tests/test_parser.py | 3 +-- tests/test_project.py | 3 +-- tests/test_pycode.py | 3 +-- tests/test_pycode_ast.py | 3 +-- tests/test_pycode_parser.py | 3 +-- tests/test_quickstart.py | 3 +-- tests/test_roles.py | 3 +-- tests/test_search.py | 3 +-- tests/test_setup_command.py | 3 +-- tests/test_smartquotes.py | 3 +-- tests/test_templating.py | 3 +-- tests/test_theming.py | 3 +-- tests/test_toctree.py | 3 +-- tests/test_transforms_post_transforms.py | 3 +-- tests/test_util.py | 3 +-- tests/test_util_docstrings.py | 3 +-- tests/test_util_docutils.py | 3 +-- tests/test_util_fileutil.py | 3 +-- tests/test_util_i18n.py | 3 +-- tests/test_util_images.py | 3 +-- tests/test_util_inspect.py | 3 +-- tests/test_util_inventory.py | 3 +-- tests/test_util_logging.py | 3 +-- tests/test_util_matching.py | 3 +-- tests/test_util_nodes.py | 3 +-- tests/test_util_rst.py | 3 +-- tests/test_util_template.py | 3 +-- tests/test_util_typing.py | 3 +-- tests/test_versioning.py | 3 +-- tests/test_writer_latex.py | 3 +-- utils/checks.py | 3 +-- utils/doclinter.py | 3 +-- 231 files changed, 231 insertions(+), 462 deletions(-) diff --git a/sphinx/__init__.py b/sphinx/__init__.py index a77d4b147..6a2bcb25b 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -1,5 +1,4 @@ -"""The Sphinx documentation toolchain. -""" +"""The Sphinx documentation toolchain.""" # Keep this file executable as-is in Python 3! # (Otherwise getting the version out of it from setup.py is impossible.) diff --git a/sphinx/__main__.py b/sphinx/__main__.py index 5caff6510..887bb6ae1 100644 --- a/sphinx/__main__.py +++ b/sphinx/__main__.py @@ -1,5 +1,4 @@ -"""The Sphinx documentation toolchain. -""" +"""The Sphinx documentation toolchain.""" import sys diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index 88545c820..bf74bd1aa 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -1,5 +1,4 @@ -"""Additional docutils nodes. -""" +"""Additional docutils nodes.""" from typing import TYPE_CHECKING, Any, Dict, List, Sequence diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index e99212dca..e1817c445 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -1,5 +1,4 @@ -"""Builder superclass for all builders. -""" +"""Builder superclass for all builders.""" import pickle import time diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index 8dec8546f..26efdc1fb 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -1,5 +1,4 @@ -"""Base class of epub2/epub3 builders. -""" +"""Base class of epub2/epub3 builders.""" import html import os diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index 5230f1a24..3a1f5bd65 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -1,5 +1,4 @@ -"""Changelog builder. -""" +"""Changelog builder.""" import html from os import path diff --git a/sphinx/builders/dirhtml.py b/sphinx/builders/dirhtml.py index 3397b9aaf..bf8af15bb 100644 --- a/sphinx/builders/dirhtml.py +++ b/sphinx/builders/dirhtml.py @@ -1,5 +1,4 @@ -"""Directory HTML builders. -""" +"""Directory HTML builders.""" from os import path from typing import Any, Dict diff --git a/sphinx/builders/dummy.py b/sphinx/builders/dummy.py index ae8bfa32a..f4f1356f6 100644 --- a/sphinx/builders/dummy.py +++ b/sphinx/builders/dummy.py @@ -1,5 +1,4 @@ -"""Do syntax checks, but no writing. -""" +"""Do syntax checks, but no writing.""" from typing import Any, Dict, Set diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index a8e9d25fd..e8bc547b7 100644 --- a/sphinx/builders/gettext.py +++ b/sphinx/builders/gettext.py @@ -1,5 +1,4 @@ -"""The MessageCatalogBuilder class. -""" +"""The MessageCatalogBuilder class.""" from codecs import open from collections import OrderedDict, defaultdict diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py index 006f06505..bbd3b91e0 100644 --- a/sphinx/builders/html/__init__.py +++ b/sphinx/builders/html/__init__.py @@ -1,5 +1,4 @@ -"""Several HTML builders. -""" +"""Several HTML builders.""" import html import os diff --git a/sphinx/builders/html/transforms.py b/sphinx/builders/html/transforms.py index 74dd3c23d..ea596cb4b 100644 --- a/sphinx/builders/html/transforms.py +++ b/sphinx/builders/html/transforms.py @@ -1,5 +1,4 @@ -"""Transforms for HTML builder. -""" +"""Transforms for HTML builder.""" import re from typing import Any, Dict, List diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index 4ee9279a2..fb33007f1 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -1,5 +1,4 @@ -"""LaTeX builder. -""" +"""LaTeX builder.""" import os import warnings diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py index d208f9a60..ace608644 100644 --- a/sphinx/builders/latex/constants.py +++ b/sphinx/builders/latex/constants.py @@ -1,5 +1,4 @@ -"""consntants for LaTeX builder. -""" +"""consntants for LaTeX builder.""" from typing import Any, Dict diff --git a/sphinx/builders/latex/nodes.py b/sphinx/builders/latex/nodes.py index adf0a0f63..2c008b9a7 100644 --- a/sphinx/builders/latex/nodes.py +++ b/sphinx/builders/latex/nodes.py @@ -1,5 +1,4 @@ -"""Additional nodes for LaTeX writer. -""" +"""Additional nodes for LaTeX writer.""" from docutils import nodes diff --git a/sphinx/builders/latex/theming.py b/sphinx/builders/latex/theming.py index 1f09ebd07..69f849381 100644 --- a/sphinx/builders/latex/theming.py +++ b/sphinx/builders/latex/theming.py @@ -1,5 +1,4 @@ -"""Theming support for LaTeX builder. -""" +"""Theming support for LaTeX builder.""" import configparser from os import path diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py index a4d6cc8e0..5e478f5c4 100644 --- a/sphinx/builders/latex/transforms.py +++ b/sphinx/builders/latex/transforms.py @@ -1,5 +1,4 @@ -"""Transforms for LaTeX builder. -""" +"""Transforms for LaTeX builder.""" from typing import Any, Dict, List, Set, Tuple, cast diff --git a/sphinx/builders/latex/util.py b/sphinx/builders/latex/util.py index 5419f2c1a..6883829c5 100644 --- a/sphinx/builders/latex/util.py +++ b/sphinx/builders/latex/util.py @@ -1,5 +1,4 @@ -"""Utilities for LaTeX builder. -""" +"""Utilities for LaTeX builder.""" from typing import Optional diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index d9d0cb3d7..a94572484 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -1,5 +1,4 @@ -"""The CheckExternalLinksBuilder class. -""" +"""The CheckExternalLinksBuilder class.""" import json import re diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index 04c154dce..43637b65a 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -1,5 +1,4 @@ -"""Manual pages builder. -""" +"""Manual pages builder.""" from os import path from typing import Any, Dict, List, Set, Tuple, Union diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py index 1a9b6a7eb..d177474a6 100644 --- a/sphinx/builders/singlehtml.py +++ b/sphinx/builders/singlehtml.py @@ -1,5 +1,4 @@ -"""Single HTML builders. -""" +"""Single HTML builders.""" from os import path from typing import Any, Dict, List, Tuple, Union diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index 6b42c4635..24a19b0df 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -1,5 +1,4 @@ -"""Texinfo builder. -""" +"""Texinfo builder.""" import os from os import path diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index 8da91d462..bcd479864 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -1,5 +1,4 @@ -"""Plain-text Sphinx builder. -""" +"""Plain-text Sphinx builder.""" from os import path from typing import Any, Dict, Iterator, Set, Tuple diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py index e16bbe36a..0f45b912c 100644 --- a/sphinx/builders/xml.py +++ b/sphinx/builders/xml.py @@ -1,5 +1,4 @@ -"""Docutils-native XML and pseudo-XML builders. -""" +"""Docutils-native XML and pseudo-XML builders.""" from os import path from typing import Any, Dict, Iterator, Set, Type, Union diff --git a/sphinx/cmd/__init__.py b/sphinx/cmd/__init__.py index 7b9ded4d3..4d277c5ea 100644 --- a/sphinx/cmd/__init__.py +++ b/sphinx/cmd/__init__.py @@ -1,2 +1 @@ -"""Modules for command line executables. -""" +"""Modules for command line executables.""" diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index 2df308b9e..00a06762a 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -1,5 +1,4 @@ -"""Build documentation from a provided source. -""" +"""Build documentation from a provided source.""" import argparse import bdb diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index 6accb75d0..e8b446d40 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -1,5 +1,4 @@ -"""Quickly setup documentation source to work with Sphinx. -""" +"""Quickly setup documentation source to work with Sphinx.""" import argparse import locale diff --git a/sphinx/config.py b/sphinx/config.py index ecbf7fa43..50de07b72 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -1,5 +1,4 @@ -"""Build configuration file handling. -""" +"""Build configuration file handling.""" import re import traceback diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py index f08465d40..5661c535d 100644 --- a/sphinx/deprecation.py +++ b/sphinx/deprecation.py @@ -1,5 +1,4 @@ -"""Sphinx deprecation classes and utilities. -""" +"""Sphinx deprecation classes and utilities.""" import sys import warnings diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index a74717377..0e5cc0c60 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -1,5 +1,4 @@ -"""Handlers for additional ReST directives. -""" +"""Handlers for additional ReST directives.""" import re from typing import TYPE_CHECKING, Any, Dict, Generic, List, Tuple, TypeVar, cast diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index ade5c4a6f..176a1def1 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -1,5 +1,4 @@ -"""The C language domain. -""" +"""The C language domain.""" import re from typing import (Any, Callable, Dict, Generator, Iterator, List, Optional, Tuple, TypeVar, diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index e9891d480..31fa44020 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -1,5 +1,4 @@ -"""The changeset domain. -""" +"""The changeset domain.""" from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, cast diff --git a/sphinx/domains/citation.py b/sphinx/domains/citation.py index e6043cc32..39e63b659 100644 --- a/sphinx/domains/citation.py +++ b/sphinx/domains/citation.py @@ -1,5 +1,4 @@ -"""The citation domain. -""" +"""The citation domain.""" from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, cast diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index d504dc5bf..e82a8f4d5 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1,5 +1,4 @@ -"""The C++ language domain. -""" +"""The C++ language domain.""" import re from typing import (Any, Callable, Dict, Generator, Iterator, List, Optional, Tuple, TypeVar, diff --git a/sphinx/domains/index.py b/sphinx/domains/index.py index 81ffe36f5..8c630c8f5 100644 --- a/sphinx/domains/index.py +++ b/sphinx/domains/index.py @@ -1,5 +1,4 @@ -"""The index domain. -""" +"""The index domain.""" from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Tuple diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 79dc3674f..ab16cdd85 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -1,5 +1,4 @@ -"""The JavaScript domain. -""" +"""The JavaScript domain.""" from typing import Any, Dict, Iterator, List, Optional, Tuple, cast diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py index ffece1f5d..6df7d30cb 100644 --- a/sphinx/domains/math.py +++ b/sphinx/domains/math.py @@ -1,5 +1,4 @@ -"""The math domain. -""" +"""The math domain.""" from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index 28e61ff46..f55d76ba0 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -1,5 +1,4 @@ -"""The Python domain. -""" +"""The Python domain.""" import builtins import inspect diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py index 9d5d82de9..f861ecad1 100644 --- a/sphinx/domains/rst.py +++ b/sphinx/domains/rst.py @@ -1,5 +1,4 @@ -"""The reStructuredText domain. -""" +"""The reStructuredText domain.""" import re from typing import Any, Dict, Iterator, List, Optional, Tuple, cast diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index 50c872511..11a3260b7 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -1,5 +1,4 @@ -"""The standard domain. -""" +"""The standard domain.""" import re import warnings diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index ef7bcae15..b5b135241 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -1,5 +1,4 @@ -"""Global creation environment. -""" +"""Global creation environment.""" import os import pickle diff --git a/sphinx/environment/adapters/__init__.py b/sphinx/environment/adapters/__init__.py index 03b8bde74..1566aecba 100644 --- a/sphinx/environment/adapters/__init__.py +++ b/sphinx/environment/adapters/__init__.py @@ -1,2 +1 @@ -"""Sphinx environment adapters -""" +"""Sphinx environment adapters""" diff --git a/sphinx/environment/adapters/asset.py b/sphinx/environment/adapters/asset.py index 29188b484..57fdc91f1 100644 --- a/sphinx/environment/adapters/asset.py +++ b/sphinx/environment/adapters/asset.py @@ -1,5 +1,4 @@ -"""Assets adapter for sphinx.environment. -""" +"""Assets adapter for sphinx.environment.""" from sphinx.environment import BuildEnvironment diff --git a/sphinx/environment/adapters/indexentries.py b/sphinx/environment/adapters/indexentries.py index 27a5f42b5..49881b76d 100644 --- a/sphinx/environment/adapters/indexentries.py +++ b/sphinx/environment/adapters/indexentries.py @@ -1,5 +1,4 @@ -"""Index entries adapters for sphinx.environment. -""" +"""Index entries adapters for sphinx.environment.""" import re import unicodedata diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index 72ce7e295..631060e75 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/sphinx/environment/adapters/toctree.py @@ -1,5 +1,4 @@ -"""Toctree adapter for sphinx.environment. -""" +"""Toctree adapter for sphinx.environment.""" from typing import TYPE_CHECKING, Any, Iterable, List, Optional, cast diff --git a/sphinx/environment/collectors/__init__.py b/sphinx/environment/collectors/__init__.py index 1da2c9807..6f12c1323 100644 --- a/sphinx/environment/collectors/__init__.py +++ b/sphinx/environment/collectors/__init__.py @@ -1,5 +1,4 @@ -"""The data collector components for sphinx.environment. -""" +"""The data collector components for sphinx.environment.""" from typing import TYPE_CHECKING, Dict, List, Optional, Set diff --git a/sphinx/environment/collectors/asset.py b/sphinx/environment/collectors/asset.py index 2cb78adf6..6bb922c66 100644 --- a/sphinx/environment/collectors/asset.py +++ b/sphinx/environment/collectors/asset.py @@ -1,5 +1,4 @@ -"""The image collector for sphinx.environment. -""" +"""The image collector for sphinx.environment.""" import os from glob import glob diff --git a/sphinx/environment/collectors/dependencies.py b/sphinx/environment/collectors/dependencies.py index 6052ede5c..87f7c29f2 100644 --- a/sphinx/environment/collectors/dependencies.py +++ b/sphinx/environment/collectors/dependencies.py @@ -1,5 +1,4 @@ -"""The dependencies collector components for sphinx.environment. -""" +"""The dependencies collector components for sphinx.environment.""" import os from os import path diff --git a/sphinx/environment/collectors/metadata.py b/sphinx/environment/collectors/metadata.py index 4075e8bc7..c70a5d408 100644 --- a/sphinx/environment/collectors/metadata.py +++ b/sphinx/environment/collectors/metadata.py @@ -1,5 +1,4 @@ -"""The metadata collector components for sphinx.environment. -""" +"""The metadata collector components for sphinx.environment.""" from typing import Any, Dict, List, Set, cast diff --git a/sphinx/environment/collectors/title.py b/sphinx/environment/collectors/title.py index 46e6e5937..10c5560fd 100644 --- a/sphinx/environment/collectors/title.py +++ b/sphinx/environment/collectors/title.py @@ -1,5 +1,4 @@ -"""The title collector components for sphinx.environment. -""" +"""The title collector components for sphinx.environment.""" from typing import Any, Dict, Set diff --git a/sphinx/environment/collectors/toctree.py b/sphinx/environment/collectors/toctree.py index 6656f3937..75c981f3c 100644 --- a/sphinx/environment/collectors/toctree.py +++ b/sphinx/environment/collectors/toctree.py @@ -1,5 +1,4 @@ -"""Toctree collector for sphinx.environment. -""" +"""Toctree collector for sphinx.environment.""" from typing import Any, Dict, List, Set, Tuple, Type, TypeVar, cast diff --git a/sphinx/errors.py b/sphinx/errors.py index c5f8ea2fe..a0263c613 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,5 +1,4 @@ -"""Contains SphinxError and a few subclasses. -""" +"""Contains SphinxError and a few subclasses.""" from typing import Any diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py index 635c4be59..16170d4cf 100644 --- a/sphinx/ext/__init__.py +++ b/sphinx/ext/__init__.py @@ -1,2 +1 @@ -"""Contains Sphinx features not activated by default. -""" +"""Contains Sphinx features not activated by default.""" diff --git a/sphinx/ext/autodoc/deprecated.py b/sphinx/ext/autodoc/deprecated.py index c20de236c..7eede8eeb 100644 --- a/sphinx/ext/autodoc/deprecated.py +++ b/sphinx/ext/autodoc/deprecated.py @@ -1,5 +1,4 @@ -"""The deprecated Documenters for autodoc. -""" +"""The deprecated Documenters for autodoc.""" import warnings from typing import Any diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py index 5d03c3f01..9d5902d2f 100644 --- a/sphinx/ext/autodoc/importer.py +++ b/sphinx/ext/autodoc/importer.py @@ -1,5 +1,4 @@ -"""Importer utilities for autodoc -""" +"""Importer utilities for autodoc""" import importlib import traceback diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py index ae49b30f0..f9e14a0cd 100644 --- a/sphinx/ext/autodoc/mock.py +++ b/sphinx/ext/autodoc/mock.py @@ -1,5 +1,4 @@ -"""mock for autodoc -""" +"""mock for autodoc""" import contextlib import os diff --git a/sphinx/ext/autodoc/type_comment.py b/sphinx/ext/autodoc/type_comment.py index 8578f282d..9881ae747 100644 --- a/sphinx/ext/autodoc/type_comment.py +++ b/sphinx/ext/autodoc/type_comment.py @@ -1,5 +1,4 @@ -"""Update annotations info of living objects using type_comments. -""" +"""Update annotations info of living objects using type_comments.""" from inspect import Parameter, Signature, getsource from typing import Any, Dict, List, cast diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py index c9099198c..2b5ceb4a6 100644 --- a/sphinx/ext/autodoc/typehints.py +++ b/sphinx/ext/autodoc/typehints.py @@ -1,5 +1,4 @@ -"""Generating content for autodoc using typehints -""" +"""Generating content for autodoc using typehints""" import re from collections import OrderedDict diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py index 315a4d24b..ff2f695ec 100644 --- a/sphinx/ext/autosectionlabel.py +++ b/sphinx/ext/autosectionlabel.py @@ -1,5 +1,4 @@ -"""Allow reference sections by :ref: role using its title. -""" +"""Allow reference sections by :ref: role using its title.""" from typing import Any, Dict, cast diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py index 9be5d4d01..94fd9077a 100644 --- a/sphinx/ext/duration.py +++ b/sphinx/ext/duration.py @@ -1,5 +1,4 @@ -"""Measure durations of Sphinx processing. -""" +"""Measure durations of Sphinx processing.""" from datetime import datetime, timedelta from itertools import islice diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py index 0f6f53cc3..e250fb2f2 100644 --- a/sphinx/ext/githubpages.py +++ b/sphinx/ext/githubpages.py @@ -1,5 +1,4 @@ -"""To publish HTML docs at GitHub Pages, create .nojekyll file. -""" +"""To publish HTML docs at GitHub Pages, create .nojekyll file.""" import os import urllib diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index 47782c06c..a40b6c46a 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -1,5 +1,4 @@ -"""Image converter extension for Sphinx -""" +"""Image converter extension for Sphinx""" import subprocess import sys diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index 29e69f45c..2c908daab 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -1,5 +1,4 @@ -"""Render math in HTML via dvipng or dvisvgm. -""" +"""Render math in HTML via dvipng or dvisvgm.""" import posixpath import re diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index 38320ea7e..ad7abd31b 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -1,5 +1,4 @@ -"""Add external links to module code in Python object descriptions. -""" +"""Add external links to module code in Python object descriptions.""" from typing import Any, Dict, Set diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index 273e3a2dd..d0dfaf825 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -1,5 +1,4 @@ -"""Support for NumPy and Google style docstrings. -""" +"""Support for NumPy and Google style docstrings.""" from typing import Any, Dict, List diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 4a96e9562..5aff7c67d 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -1,5 +1,4 @@ -"""Add links to module code in Python object descriptions. -""" +"""Add links to module code in Python object descriptions.""" import posixpath import traceback diff --git a/sphinx/extension.py b/sphinx/extension.py index e11d75f8f..356b4ab9d 100644 --- a/sphinx/extension.py +++ b/sphinx/extension.py @@ -1,5 +1,4 @@ -"""Utilities for Sphinx extensions. -""" +"""Utilities for Sphinx extensions.""" from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 52fe098dc..a7e5e4940 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -1,5 +1,4 @@ -"""Highlight code blocks using Pygments. -""" +"""Highlight code blocks using Pygments.""" from functools import partial from importlib import import_module diff --git a/sphinx/io.py b/sphinx/io.py index 3d4be299f..936631d51 100644 --- a/sphinx/io.py +++ b/sphinx/io.py @@ -1,5 +1,4 @@ -"""Input/Output files -""" +"""Input/Output files""" import codecs from typing import TYPE_CHECKING, Any, List, Type diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index a38338d24..a0d1f65ea 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -1,5 +1,4 @@ -"""Glue code for the jinja2 templating engine. -""" +"""Glue code for the jinja2 templating engine.""" from os import path from pprint import pformat diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py index 03f91b1f3..b9bdff0f9 100644 --- a/sphinx/locale/__init__.py +++ b/sphinx/locale/__init__.py @@ -1,5 +1,4 @@ -"""Locale utilities. -""" +"""Locale utilities.""" import gettext import locale diff --git a/sphinx/parsers.py b/sphinx/parsers.py index 2665d1265..b044f983b 100644 --- a/sphinx/parsers.py +++ b/sphinx/parsers.py @@ -1,5 +1,4 @@ -"""A Base class for additional parsers. -""" +"""A Base class for additional parsers.""" import warnings from typing import TYPE_CHECKING, Any, Dict, List, Type, Union diff --git a/sphinx/project.py b/sphinx/project.py index 63d5819fd..134055866 100644 --- a/sphinx/project.py +++ b/sphinx/project.py @@ -1,5 +1,4 @@ -"""Utility function and classes for Sphinx projects. -""" +"""Utility function and classes for Sphinx projects.""" import os from glob import glob diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index 96fba91a1..5f386d62f 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -1,5 +1,4 @@ -"""Utilities parsing and analyzing Python code. -""" +"""Utilities parsing and analyzing Python code.""" import re import tokenize diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py index 7f5e40d4d..755116475 100644 --- a/sphinx/pycode/ast.py +++ b/sphinx/pycode/ast.py @@ -1,5 +1,4 @@ -"""Helpers for AST (Abstract Syntax Tree). -""" +"""Helpers for AST (Abstract Syntax Tree).""" import sys from typing import Dict, List, Optional, Type, overload diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py index 303d7ae27..ff1135c25 100644 --- a/sphinx/pycode/parser.py +++ b/sphinx/pycode/parser.py @@ -1,5 +1,4 @@ -"""Utilities parsing and analyzing Python code. -""" +"""Utilities parsing and analyzing Python code.""" import inspect import itertools import re diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py index 2d5e23c67..ffc7f7f0b 100644 --- a/sphinx/pygments_styles.py +++ b/sphinx/pygments_styles.py @@ -1,5 +1,4 @@ -"""Sphinx theme specific highlighting styles. -""" +"""Sphinx theme specific highlighting styles.""" from pygments.style import Style from pygments.styles.friendly import FriendlyStyle diff --git a/sphinx/registry.py b/sphinx/registry.py index b51d07d3a..0f8010956 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -1,5 +1,4 @@ -"""Sphinx component registry. -""" +"""Sphinx component registry.""" import traceback import warnings diff --git a/sphinx/roles.py b/sphinx/roles.py index 73d7feb0e..5e467937b 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -1,5 +1,4 @@ -"""Handlers for additional ReST roles. -""" +"""Handlers for additional ReST roles.""" import re from typing import TYPE_CHECKING, Any, Dict, List, Tuple, Type diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index 00e209603..5fa35ae16 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -1,5 +1,4 @@ -"""Create a full-text search index for offline search. -""" +"""Create a full-text search index for offline search.""" import html import pickle import re diff --git a/sphinx/search/da.py b/sphinx/search/da.py index 5c3d138dd..42559ad93 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -1,5 +1,4 @@ -"""Danish search language: includes the JS Danish stemmer. -""" +"""Danish search language: includes the JS Danish stemmer.""" from typing import Dict diff --git a/sphinx/search/de.py b/sphinx/search/de.py index 8223f11f1..3896629de 100644 --- a/sphinx/search/de.py +++ b/sphinx/search/de.py @@ -1,5 +1,4 @@ -"""German search language: includes the JS German stemmer. -""" +"""German search language: includes the JS German stemmer.""" from typing import Dict diff --git a/sphinx/search/en.py b/sphinx/search/en.py index 2f2f157e8..53cd917dc 100644 --- a/sphinx/search/en.py +++ b/sphinx/search/en.py @@ -1,5 +1,4 @@ -"""English search language: includes the JS porter stemmer. -""" +"""English search language: includes the JS porter stemmer.""" from typing import Dict diff --git a/sphinx/search/es.py b/sphinx/search/es.py index 79e7e76d3..7aba54bfd 100644 --- a/sphinx/search/es.py +++ b/sphinx/search/es.py @@ -1,5 +1,4 @@ -"""Spanish search language: includes the JS Spanish stemmer. -""" +"""Spanish search language: includes the JS Spanish stemmer.""" from typing import Dict diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py index 9ca7f9d05..36f7e7747 100644 --- a/sphinx/search/fi.py +++ b/sphinx/search/fi.py @@ -1,5 +1,4 @@ -"""Finnish search language: includes the JS Finnish stemmer. -""" +"""Finnish search language: includes the JS Finnish stemmer.""" from typing import Dict diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py index ad1ac547a..a469bc922 100644 --- a/sphinx/search/fr.py +++ b/sphinx/search/fr.py @@ -1,5 +1,4 @@ -"""French search language: includes the JS French stemmer. -""" +"""French search language: includes the JS French stemmer.""" from typing import Dict diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py index 46e8eae09..23f7d85bb 100644 --- a/sphinx/search/hu.py +++ b/sphinx/search/hu.py @@ -1,5 +1,4 @@ -"""Hungarian search language: includes the JS Hungarian stemmer. -""" +"""Hungarian search language: includes the JS Hungarian stemmer.""" from typing import Dict diff --git a/sphinx/search/it.py b/sphinx/search/it.py index c42e0ae54..80b3b3a6d 100644 --- a/sphinx/search/it.py +++ b/sphinx/search/it.py @@ -1,5 +1,4 @@ -"""Italian search language: includes the JS Italian stemmer. -""" +"""Italian search language: includes the JS Italian stemmer.""" from typing import Dict diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index 5d18b702a..38520edc3 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -1,5 +1,4 @@ -"""Japanese search language: includes routine to split words. -""" +"""Japanese search language: includes routine to split words.""" # Python Version of TinySegmenter # (http://chasen.org/~taku/software/TinySegmenter/) diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py index abb958fb9..b5c549f66 100644 --- a/sphinx/search/nl.py +++ b/sphinx/search/nl.py @@ -1,5 +1,4 @@ -"""Dutch search language: includes the JS porter stemmer. -""" +"""Dutch search language: includes the JS porter stemmer.""" from typing import Dict diff --git a/sphinx/search/no.py b/sphinx/search/no.py index 67c338675..f11f3cf15 100644 --- a/sphinx/search/no.py +++ b/sphinx/search/no.py @@ -1,5 +1,4 @@ -"""Norwegian search language: includes the JS Norwegian stemmer. -""" +"""Norwegian search language: includes the JS Norwegian stemmer.""" from typing import Dict diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py index 84408e795..1708928b2 100644 --- a/sphinx/search/pt.py +++ b/sphinx/search/pt.py @@ -1,5 +1,4 @@ -"""Portuguese search language: includes the JS Portuguese stemmer. -""" +"""Portuguese search language: includes the JS Portuguese stemmer.""" from typing import Dict diff --git a/sphinx/search/ro.py b/sphinx/search/ro.py index 46426f25e..4c8a22711 100644 --- a/sphinx/search/ro.py +++ b/sphinx/search/ro.py @@ -1,5 +1,4 @@ -"""Romanian search language: includes the JS Romanian stemmer. -""" +"""Romanian search language: includes the JS Romanian stemmer.""" from typing import Dict, Set diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index 778f18da6..6c4f8da94 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -1,5 +1,4 @@ -"""Russian search language: includes the JS Russian stemmer. -""" +"""Russian search language: includes the JS Russian stemmer.""" from typing import Dict diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py index b74d8980f..176cc8da4 100644 --- a/sphinx/search/sv.py +++ b/sphinx/search/sv.py @@ -1,5 +1,4 @@ -"""Swedish search language: includes the JS Swedish stemmer. -""" +"""Swedish search language: includes the JS Swedish stemmer.""" from typing import Dict diff --git a/sphinx/search/tr.py b/sphinx/search/tr.py index 1338c7116..78d48aed0 100644 --- a/sphinx/search/tr.py +++ b/sphinx/search/tr.py @@ -1,5 +1,4 @@ -"""Turkish search language: includes the JS Turkish stemmer. -""" +"""Turkish search language: includes the JS Turkish stemmer.""" from typing import Dict, Set diff --git a/sphinx/search/zh.py b/sphinx/search/zh.py index 46f486bd3..700c2683f 100644 --- a/sphinx/search/zh.py +++ b/sphinx/search/zh.py @@ -1,5 +1,4 @@ -"""Chinese search language: includes routine to split words. -""" +"""Chinese search language: includes routine to split words.""" import os import re diff --git a/sphinx/testing/comparer.py b/sphinx/testing/comparer.py index 370bd264d..09e8364bd 100644 --- a/sphinx/testing/comparer.py +++ b/sphinx/testing/comparer.py @@ -1,5 +1,4 @@ -"""Sphinx test comparer for pytest -""" +"""Sphinx test comparer for pytest""" import difflib import pathlib from typing import Any, List, Union diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py index 2f00ca974..0b558e32c 100644 --- a/sphinx/testing/fixtures.py +++ b/sphinx/testing/fixtures.py @@ -1,5 +1,4 @@ -"""Sphinx test fixtures for pytest -""" +"""Sphinx test fixtures for pytest""" import subprocess import sys diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py index bea449257..441e6da3b 100644 --- a/sphinx/testing/util.py +++ b/sphinx/testing/util.py @@ -1,5 +1,4 @@ -"""Sphinx test suite utilities -""" +"""Sphinx test suite utilities""" import functools import os import re diff --git a/sphinx/theming.py b/sphinx/theming.py index 3b662dd00..6b8f79c3d 100644 --- a/sphinx/theming.py +++ b/sphinx/theming.py @@ -1,5 +1,4 @@ -"""Theming support for HTML builders. -""" +"""Theming support for HTML builders.""" import configparser import os diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py index 3fa74c45b..a2a592221 100644 --- a/sphinx/transforms/__init__.py +++ b/sphinx/transforms/__init__.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx when reading documents. -""" +"""Docutils transforms used by Sphinx when reading documents.""" import re import unicodedata diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py index b35df3cb1..4bf633237 100644 --- a/sphinx/transforms/compact_bullet_list.py +++ b/sphinx/transforms/compact_bullet_list.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx when reading documents. -""" +"""Docutils transforms used by Sphinx when reading documents.""" from typing import Any, Dict, List, cast diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py index a45ec02d1..4909cebc1 100644 --- a/sphinx/transforms/i18n.py +++ b/sphinx/transforms/i18n.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx when reading documents. -""" +"""Docutils transforms used by Sphinx when reading documents.""" from os import path from textwrap import indent diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py index 9b3c84edf..94a162963 100644 --- a/sphinx/transforms/post_transforms/__init__.py +++ b/sphinx/transforms/post_transforms/__init__.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx. -""" +"""Docutils transforms used by Sphinx.""" import re from typing import Any, Dict, List, Optional, Sequence, Tuple, Type, cast diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index a47555bd1..3c3f54328 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -1,5 +1,4 @@ -"""transforms for code-blocks. -""" +"""transforms for code-blocks.""" import sys from typing import Any, Dict, List, NamedTuple diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py index 3f2c99b0f..ac9c4225e 100644 --- a/sphinx/transforms/post_transforms/images.py +++ b/sphinx/transforms/post_transforms/images.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx. -""" +"""Docutils transforms used by Sphinx.""" import os import re diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py index da899f952..647c83e12 100644 --- a/sphinx/transforms/references.py +++ b/sphinx/transforms/references.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx. -""" +"""Docutils transforms used by Sphinx.""" from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 9dd30289a..ee98c29c8 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -1,5 +1,4 @@ -"""Utility functions for Sphinx. -""" +"""Utility functions for Sphinx.""" import functools import hashlib diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py index 8a45eabb2..7f80aa576 100644 --- a/sphinx/util/build_phase.py +++ b/sphinx/util/build_phase.py @@ -1,5 +1,4 @@ -"""Build phase of Sphinx application. -""" +"""Build phase of Sphinx application.""" from enum import IntEnum diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py index c382a5634..38dc3fd21 100644 --- a/sphinx/util/cfamily.py +++ b/sphinx/util/cfamily.py @@ -1,5 +1,4 @@ -"""Utility functions common to the C and C++ domains. -""" +"""Utility functions common to the C and C++ domains.""" import re from copy import deepcopy diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 58ca9e1b0..7f332fda7 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -1,5 +1,4 @@ -"""modules for backward compatibility -""" +"""modules for backward compatibility""" import sys from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/util/console.py b/sphinx/util/console.py index 22bb01514..cc22390a5 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -1,5 +1,4 @@ -"""Format colored console output. -""" +"""Format colored console output.""" import os import re diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index d952fa11b..11c823b33 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,5 +1,4 @@ -"""Utilities for docstring processing. -""" +"""Utilities for docstring processing.""" import re import sys diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index 07a17be79..654a7a98b 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -1,5 +1,4 @@ -"""Utility functions for docutils. -""" +"""Utility functions for docutils.""" import os import re diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py index c3ce9633c..f706fa69a 100644 --- a/sphinx/util/fileutil.py +++ b/sphinx/util/fileutil.py @@ -1,5 +1,4 @@ -"""File utility functions for Sphinx. -""" +"""File utility functions for Sphinx.""" import os import posixpath diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py index a7706e899..f3bb002a3 100644 --- a/sphinx/util/i18n.py +++ b/sphinx/util/i18n.py @@ -1,5 +1,4 @@ -"""Builder superclass for all builders. -""" +"""Builder superclass for all builders.""" import os import re diff --git a/sphinx/util/images.py b/sphinx/util/images.py index a6d0918a0..2def252f4 100644 --- a/sphinx/util/images.py +++ b/sphinx/util/images.py @@ -1,5 +1,4 @@ -"""Image utility functions for Sphinx. -""" +"""Image utility functions for Sphinx.""" import base64 import imghdr diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index c9a4eb725..5b4e2586e 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -1,5 +1,4 @@ -"""Helpers for inspecting Python modules. -""" +"""Helpers for inspecting Python modules.""" import builtins import contextlib diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py index d46a0916d..7827aec74 100644 --- a/sphinx/util/inventory.py +++ b/sphinx/util/inventory.py @@ -1,5 +1,4 @@ -"""Inventory utility functions for Sphinx. -""" +"""Inventory utility functions for Sphinx.""" import os import re import zlib diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py index 3e1dad784..37fa672af 100644 --- a/sphinx/util/logging.py +++ b/sphinx/util/logging.py @@ -1,5 +1,4 @@ -"""Logging utility functions for Sphinx. -""" +"""Logging utility functions for Sphinx.""" import logging import logging.handlers diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index 4aede2763..53a893338 100644 --- a/sphinx/util/matching.py +++ b/sphinx/util/matching.py @@ -1,5 +1,4 @@ -"""Pattern-matching utility functions for Sphinx. -""" +"""Pattern-matching utility functions for Sphinx.""" import re from typing import Callable, Dict, Iterable, List, Match, Optional, Pattern diff --git a/sphinx/util/math.py b/sphinx/util/math.py index 56523e10f..7caf662dc 100644 --- a/sphinx/util/math.py +++ b/sphinx/util/math.py @@ -1,5 +1,4 @@ -"""Utility functions for math. -""" +"""Utility functions for math.""" from docutils import nodes diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index aff3d1875..4abc3afa4 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -1,5 +1,4 @@ -"""Docutils node-related utility functions for Sphinx. -""" +"""Docutils node-related utility functions for Sphinx.""" import re import unicodedata diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index 7ce114aa0..1af722fdc 100644 --- a/sphinx/util/osutil.py +++ b/sphinx/util/osutil.py @@ -1,5 +1,4 @@ -"""Operating system-related utility functions for Sphinx. -""" +"""Operating system-related utility functions for Sphinx.""" import contextlib import filecmp diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index 39a5c741c..e4bd852b0 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -1,5 +1,4 @@ -"""Parallel building utilities. -""" +"""Parallel building utilities.""" import os import time diff --git a/sphinx/util/png.py b/sphinx/util/png.py index 0234ab9fd..cb7ee8be4 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -1,5 +1,4 @@ -"""PNG image manipulation helpers. -""" +"""PNG image manipulation helpers.""" import binascii import struct diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index 51f5af90d..aedbd143d 100644 --- a/sphinx/util/pycompat.py +++ b/sphinx/util/pycompat.py @@ -1,5 +1,4 @@ -"""Stuff for Python version compatibility. -""" +"""Stuff for Python version compatibility.""" import warnings from typing import Any, Callable diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py index 834274df2..b1bcb6bd3 100644 --- a/sphinx/util/requests.py +++ b/sphinx/util/requests.py @@ -1,5 +1,4 @@ -"""Simple requests package loader -""" +"""Simple requests package loader""" import sys import warnings diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index aa9b335bc..b44cf9848 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -1,5 +1,4 @@ -"""reST helper functions. -""" +"""reST helper functions.""" import re from collections import defaultdict diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py index 16a8d7ac8..ff6c365c7 100644 --- a/sphinx/util/stemmer/__init__.py +++ b/sphinx/util/stemmer/__init__.py @@ -1,5 +1,4 @@ -"""Word stemming utilities for Sphinx. -""" +"""Word stemming utilities for Sphinx.""" from sphinx.util.stemmer.porter import PorterStemmer diff --git a/sphinx/util/template.py b/sphinx/util/template.py index 803fd4bad..5a73515b3 100644 --- a/sphinx/util/template.py +++ b/sphinx/util/template.py @@ -1,5 +1,4 @@ -"""Templates utility functions for Sphinx. -""" +"""Templates utility functions for Sphinx.""" import os from functools import partial diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index b25cb62c3..83c78bb38 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -1,5 +1,4 @@ -"""TeX escaping helper. -""" +"""TeX escaping helper.""" import re from typing import Dict diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py index 203205990..1534b2c8e 100644 --- a/sphinx/util/typing.py +++ b/sphinx/util/typing.py @@ -1,5 +1,4 @@ -"""The composite types for Sphinx. -""" +"""The composite types for Sphinx.""" import sys import typing diff --git a/sphinx/versioning.py b/sphinx/versioning.py index d34cf4df3..06cf33cc0 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -1,5 +1,4 @@ -"""Implements the low-level algorithms Sphinx uses for versioning doctrees. -""" +"""Implements the low-level algorithms Sphinx uses for versioning doctrees.""" import pickle from itertools import product, zip_longest from operator import itemgetter diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py index 30487d18e..e90088e6d 100644 --- a/sphinx/writers/__init__.py +++ b/sphinx/writers/__init__.py @@ -1,2 +1 @@ -"""Custom docutils writers. -""" +"""Custom docutils writers.""" diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index d5b1ad30a..49a4b0349 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -1,5 +1,4 @@ -"""docutils writers handling Sphinx' custom nodes. -""" +"""docutils writers handling Sphinx' custom nodes.""" import os import posixpath diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index bff8fcd09..43d403e6d 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -1,5 +1,4 @@ -"""Experimental docutils writers for HTML5 handling Sphinx's custom nodes. -""" +"""Experimental docutils writers for HTML5 handling Sphinx's custom nodes.""" import os import posixpath diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index 7f97c52d3..10e91f4a3 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -1,5 +1,4 @@ -"""Manual page writer, extended for Sphinx custom nodes. -""" +"""Manual page writer, extended for Sphinx custom nodes.""" from typing import Any, Dict, Iterable, cast diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index 5a14cab45..b40f032b4 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -1,5 +1,4 @@ -"""Custom docutils writer for Texinfo. -""" +"""Custom docutils writer for Texinfo.""" import re import textwrap diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 7dc199354..8df01012c 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -1,5 +1,4 @@ -"""Custom docutils writer for plain text. -""" +"""Custom docutils writer for plain text.""" import math import os import re diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py index b3cd19edc..5f9aad7fa 100644 --- a/sphinx/writers/xml.py +++ b/sphinx/writers/xml.py @@ -1,5 +1,4 @@ -"""Docutils-native XML and pseudo-XML writers. -""" +"""Docutils-native XML and pseudo-XML writers.""" from typing import Any diff --git a/tests/ext_napoleon_pep526_data_google.py b/tests/ext_napoleon_pep526_data_google.py index e9a00b72c..bb55b0fc2 100644 --- a/tests/ext_napoleon_pep526_data_google.py +++ b/tests/ext_napoleon_pep526_data_google.py @@ -1,5 +1,4 @@ -"""Test module for napoleon PEP 526 compatibility with google style -""" +"""Test module for napoleon PEP 526 compatibility with google style""" module_level_var: int = 99 """This is an example module level variable""" diff --git a/tests/ext_napoleon_pep526_data_numpy.py b/tests/ext_napoleon_pep526_data_numpy.py index 6d31973f5..b3093a7f4 100644 --- a/tests/ext_napoleon_pep526_data_numpy.py +++ b/tests/ext_napoleon_pep526_data_numpy.py @@ -1,5 +1,4 @@ -"""Test module for napoleon PEP 526 compatibility with numpy style -""" +"""Test module for napoleon PEP 526 compatibility with numpy style""" module_level_var: int = 99 """This is an example module level variable""" diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py index d18d1eee2..aad5a2ccc 100644 --- a/tests/test_api_translator.py +++ b/tests/test_api_translator.py @@ -1,5 +1,4 @@ -"""Test the Sphinx API for translator. -""" +"""Test the Sphinx API for translator.""" import sys diff --git a/tests/test_application.py b/tests/test_application.py index 82dc88d74..365fff8ea 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -1,5 +1,4 @@ -"""Test the Sphinx class. -""" +"""Test the Sphinx class.""" from unittest.mock import Mock diff --git a/tests/test_build.py b/tests/test_build.py index 8cb4da0e4..f2af19565 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -1,5 +1,4 @@ -"""Test all builders. -""" +"""Test all builders.""" import sys from textwrap import dedent diff --git a/tests/test_build_changes.py b/tests/test_build_changes.py index d3ef56c5b..a4a07619b 100644 --- a/tests/test_build_changes.py +++ b/tests/test_build_changes.py @@ -1,5 +1,4 @@ -"""Test the ChangesBuilder class. -""" +"""Test the ChangesBuilder class.""" import pytest diff --git a/tests/test_build_dirhtml.py b/tests/test_build_dirhtml.py index ce16299a6..25598f795 100644 --- a/tests/test_build_dirhtml.py +++ b/tests/test_build_dirhtml.py @@ -1,5 +1,4 @@ -"""Test dirhtml builder. -""" +"""Test dirhtml builder.""" import posixpath diff --git a/tests/test_build_epub.py b/tests/test_build_epub.py index 820ac9727..4ba29df85 100644 --- a/tests/test_build_epub.py +++ b/tests/test_build_epub.py @@ -1,5 +1,4 @@ -"""Test the HTML builder and check output against XPath. -""" +"""Test the HTML builder and check output against XPath.""" import os import subprocess diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index 370efa777..6d80324bd 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -1,5 +1,4 @@ -"""Test the build process with gettext builder with the test root. -""" +"""Test the build process with gettext builder with the test root.""" import gettext import os diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 660d7f7ec..f50f72a9c 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -1,5 +1,4 @@ -"""Test the HTML builder and check output against XPath. -""" +"""Test the HTML builder and check output against XPath.""" import os import re diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 7ac9bdcbb..938e8a820 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -1,5 +1,4 @@ -"""Test the build process with LaTeX builder with the test root. -""" +"""Test the build process with LaTeX builder with the test root.""" import os import re diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py index 2c8d8f3eb..d5684ba6c 100644 --- a/tests/test_build_linkcheck.py +++ b/tests/test_build_linkcheck.py @@ -1,5 +1,4 @@ -"""Test the build process with manpage builder with the test root. -""" +"""Test the build process with manpage builder with the test root.""" import http.server import json diff --git a/tests/test_build_manpage.py b/tests/test_build_manpage.py index c890b4734..c6139c2bf 100644 --- a/tests/test_build_manpage.py +++ b/tests/test_build_manpage.py @@ -1,5 +1,4 @@ -"""Test the build process with manpage builder with the test root. -""" +"""Test the build process with manpage builder with the test root.""" import pytest diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py index 3dfb43c11..ccdbd9bd3 100644 --- a/tests/test_build_texinfo.py +++ b/tests/test_build_texinfo.py @@ -1,5 +1,4 @@ -"""Test the build process with Texinfo builder with the test root. -""" +"""Test the build process with Texinfo builder with the test root.""" import os import re diff --git a/tests/test_build_text.py b/tests/test_build_text.py index a8420d79e..0578e425e 100644 --- a/tests/test_build_text.py +++ b/tests/test_build_text.py @@ -1,5 +1,4 @@ -"""Test the build process with Text builder with the test root. -""" +"""Test the build process with Text builder with the test root.""" import pytest from docutils.utils import column_width diff --git a/tests/test_builder.py b/tests/test_builder.py index c51e1203f..c866a9720 100644 --- a/tests/test_builder.py +++ b/tests/test_builder.py @@ -1,5 +1,4 @@ -"""Test the Builder class. -""" +"""Test the Builder class.""" import pytest diff --git a/tests/test_catalogs.py b/tests/test_catalogs.py index 4e21bf0cb..74aa7077a 100644 --- a/tests/test_catalogs.py +++ b/tests/test_catalogs.py @@ -1,5 +1,4 @@ -"""Test the base build process. -""" +"""Test the base build process.""" import shutil import pytest diff --git a/tests/test_config.py b/tests/test_config.py index 83aca3ae1..7981dd7a9 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -1,5 +1,4 @@ -"""Test the sphinx.config.Config class. -""" +"""Test the sphinx.config.Config class.""" from unittest import mock diff --git a/tests/test_correct_year.py b/tests/test_correct_year.py index a672049b3..3855df913 100644 --- a/tests/test_correct_year.py +++ b/tests/test_correct_year.py @@ -1,5 +1,4 @@ -"""Test copyright year adjustment -""" +"""Test copyright year adjustment""" import pytest diff --git a/tests/test_directive_code.py b/tests/test_directive_code.py index 824c304ff..98a9aa899 100644 --- a/tests/test_directive_code.py +++ b/tests/test_directive_code.py @@ -1,5 +1,4 @@ -"""Test the code-block directive. -""" +"""Test the code-block directive.""" import os diff --git a/tests/test_directive_only.py b/tests/test_directive_only.py index e35fba580..2e9ea634c 100644 --- a/tests/test_directive_only.py +++ b/tests/test_directive_only.py @@ -1,5 +1,4 @@ -"""Test the only directive with the test root. -""" +"""Test the only directive with the test root.""" import re diff --git a/tests/test_directive_other.py b/tests/test_directive_other.py index e9bb147ed..f221db075 100644 --- a/tests/test_directive_other.py +++ b/tests/test_directive_other.py @@ -1,5 +1,4 @@ -"""Test the other directives. -""" +"""Test the other directives.""" import pytest from docutils import nodes diff --git a/tests/test_directive_patch.py b/tests/test_directive_patch.py index 23877ae13..f4eb8f9db 100644 --- a/tests/test_directive_patch.py +++ b/tests/test_directive_patch.py @@ -1,5 +1,4 @@ -"""Test the patched directives. -""" +"""Test the patched directives.""" import pytest from docutils import nodes diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py index a18eb7043..def6cb67d 100644 --- a/tests/test_docutilsconf.py +++ b/tests/test_docutilsconf.py @@ -1,5 +1,4 @@ -"""Test docutils.conf support for several writers. -""" +"""Test docutils.conf support for several writers.""" import pytest from docutils import nodes diff --git a/tests/test_domain_c.py b/tests/test_domain_c.py index c3d14b239..16a71d9fe 100644 --- a/tests/test_domain_c.py +++ b/tests/test_domain_c.py @@ -1,5 +1,4 @@ -"""Tests the C Domain -""" +"""Tests the C Domain""" import itertools import zlib diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index f3b641414..234f6570e 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -1,5 +1,4 @@ -"""Tests the C++ Domain -""" +"""Tests the C++ Domain""" import itertools import re diff --git a/tests/test_domain_js.py b/tests/test_domain_js.py index 773db4bb8..465fef328 100644 --- a/tests/test_domain_js.py +++ b/tests/test_domain_js.py @@ -1,5 +1,4 @@ -"""Tests the JavaScript Domain -""" +"""Tests the JavaScript Domain""" from unittest.mock import Mock diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py index 75d46a46f..4205ada13 100644 --- a/tests/test_domain_py.py +++ b/tests/test_domain_py.py @@ -1,5 +1,4 @@ -"""Tests the Python Domain -""" +"""Tests the Python Domain""" import re import sys diff --git a/tests/test_domain_rst.py b/tests/test_domain_rst.py index afe7ae8b8..df19ffdb2 100644 --- a/tests/test_domain_rst.py +++ b/tests/test_domain_rst.py @@ -1,5 +1,4 @@ -"""Tests the reStructuredText domain. -""" +"""Tests the reStructuredText domain.""" from sphinx import addnodes from sphinx.addnodes import (desc, desc_addname, desc_annotation, desc_content, desc_name, diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py index 42c0e0ce0..e92030517 100644 --- a/tests/test_domain_std.py +++ b/tests/test_domain_std.py @@ -1,5 +1,4 @@ -"""Tests the std domain -""" +"""Tests the std domain""" from unittest import mock diff --git a/tests/test_environment.py b/tests/test_environment.py index e244d3841..7ffca7898 100644 --- a/tests/test_environment.py +++ b/tests/test_environment.py @@ -1,5 +1,4 @@ -"""Test the BuildEnvironment class. -""" +"""Test the BuildEnvironment class.""" import os import shutil diff --git a/tests/test_environment_indexentries.py b/tests/test_environment_indexentries.py index 38fc3021e..5b7678499 100644 --- a/tests/test_environment_indexentries.py +++ b/tests/test_environment_indexentries.py @@ -1,5 +1,4 @@ -"""Test the sphinx.environment.managers.indexentries. -""" +"""Test the sphinx.environment.managers.indexentries.""" import pytest diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py index 803519261..588bcac18 100644 --- a/tests/test_environment_toctree.py +++ b/tests/test_environment_toctree.py @@ -1,5 +1,4 @@ -"""Test the sphinx.environment.managers.toctree. -""" +"""Test the sphinx.environment.managers.toctree.""" import pytest from docutils import nodes diff --git a/tests/test_events.py b/tests/test_events.py index 44d80f1c0..f36c86a87 100644 --- a/tests/test_events.py +++ b/tests/test_events.py @@ -1,5 +1,4 @@ -"""Test the EventManager class. -""" +"""Test the EventManager class.""" import pytest diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py index c58882c6e..7aba847a3 100644 --- a/tests/test_ext_apidoc.py +++ b/tests/test_ext_apidoc.py @@ -1,5 +1,4 @@ -"""Test the sphinx.apidoc module. -""" +"""Test the sphinx.apidoc module.""" from collections import namedtuple diff --git a/tests/test_ext_autodoc_configs.py b/tests/test_ext_autodoc_configs.py index 3ed2fc38b..f3d5ffe06 100644 --- a/tests/test_ext_autodoc_configs.py +++ b/tests/test_ext_autodoc_configs.py @@ -1,5 +1,4 @@ -"""Test the autodoc extension. This tests mainly for config variables -""" +"""Test the autodoc extension. This tests mainly for config variables""" import platform import sys diff --git a/tests/test_ext_autodoc_events.py b/tests/test_ext_autodoc_events.py index bde25cd37..91e1d27d2 100644 --- a/tests/test_ext_autodoc_events.py +++ b/tests/test_ext_autodoc_events.py @@ -1,5 +1,4 @@ -"""Test the autodoc extension. This tests mainly for autodoc events -""" +"""Test the autodoc extension. This tests mainly for autodoc events""" import pytest diff --git a/tests/test_ext_autodoc_mock.py b/tests/test_ext_autodoc_mock.py index 43493959f..0f3288c28 100644 --- a/tests/test_ext_autodoc_mock.py +++ b/tests/test_ext_autodoc_mock.py @@ -1,5 +1,4 @@ -"""Test the autodoc extension. -""" +"""Test the autodoc extension.""" import abc import sys diff --git a/tests/test_ext_autodoc_preserve_defaults.py b/tests/test_ext_autodoc_preserve_defaults.py index bb239a2bb..563bfe35b 100644 --- a/tests/test_ext_autodoc_preserve_defaults.py +++ b/tests/test_ext_autodoc_preserve_defaults.py @@ -1,5 +1,4 @@ -"""Test the autodoc extension. -""" +"""Test the autodoc extension.""" import sys diff --git a/tests/test_ext_autosectionlabel.py b/tests/test_ext_autosectionlabel.py index 4aaf010bb..7345ca3ff 100644 --- a/tests/test_ext_autosectionlabel.py +++ b/tests/test_ext_autosectionlabel.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.autosectionlabel extension. -""" +"""Test sphinx.ext.autosectionlabel extension.""" import re diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py index 26909080d..fd77db816 100644 --- a/tests/test_ext_autosummary.py +++ b/tests/test_ext_autosummary.py @@ -1,5 +1,4 @@ -"""Test the autosummary extension. -""" +"""Test the autosummary extension.""" import sys from io import StringIO diff --git a/tests/test_ext_coverage.py b/tests/test_ext_coverage.py index 803e234e2..ee179a86b 100644 --- a/tests/test_ext_coverage.py +++ b/tests/test_ext_coverage.py @@ -1,5 +1,4 @@ -"""Test the coverage builder. -""" +"""Test the coverage builder.""" import pickle diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index 6cfff441f..6e8a4123e 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -1,5 +1,4 @@ -"""Test the doctest extension. -""" +"""Test the doctest extension.""" import os from collections import Counter diff --git a/tests/test_ext_duration.py b/tests/test_ext_duration.py index 05f3ef422..4fa4dfc30 100644 --- a/tests/test_ext_duration.py +++ b/tests/test_ext_duration.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.duration extension. -""" +"""Test sphinx.ext.duration extension.""" import re diff --git a/tests/test_ext_githubpages.py b/tests/test_ext_githubpages.py index 7f60d7492..445719e12 100644 --- a/tests/test_ext_githubpages.py +++ b/tests/test_ext_githubpages.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.githubpages extension. -""" +"""Test sphinx.ext.githubpages extension.""" import pytest diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py index c6a688bb5..7ffe7ead2 100644 --- a/tests/test_ext_graphviz.py +++ b/tests/test_ext_graphviz.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.graphviz extension. -""" +"""Test sphinx.ext.graphviz extension.""" import re diff --git a/tests/test_ext_ifconfig.py b/tests/test_ext_ifconfig.py index 1a6625026..3c4651b3f 100644 --- a/tests/test_ext_ifconfig.py +++ b/tests/test_ext_ifconfig.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.ifconfig extension. -""" +"""Test sphinx.ext.ifconfig extension.""" import pytest diff --git a/tests/test_ext_imgconverter.py b/tests/test_ext_imgconverter.py index 8fee95746..134947c87 100644 --- a/tests/test_ext_imgconverter.py +++ b/tests/test_ext_imgconverter.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.imgconverter extension. -""" +"""Test sphinx.ext.imgconverter extension.""" import os diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py index db7944218..a6218eccc 100644 --- a/tests/test_ext_inheritance_diagram.py +++ b/tests/test_ext_inheritance_diagram.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.inheritance_diagram extension. -""" +"""Test sphinx.ext.inheritance_diagram extension.""" import os import re diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py index 8e45890aa..7d52ff95e 100644 --- a/tests/test_ext_intersphinx.py +++ b/tests/test_ext_intersphinx.py @@ -1,5 +1,4 @@ -"""Test the intersphinx extension. -""" +"""Test the intersphinx extension.""" import http.server import os diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index b251e41d2..e3345e627 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -1,5 +1,4 @@ -"""Test math extensions. -""" +"""Test math extensions.""" import re import subprocess diff --git a/tests/test_ext_todo.py b/tests/test_ext_todo.py index 15ecc1bed..ffe8bd995 100644 --- a/tests/test_ext_todo.py +++ b/tests/test_ext_todo.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.todo extension. -""" +"""Test sphinx.ext.todo extension.""" import re diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py index 11aacfc43..c2e195428 100644 --- a/tests/test_ext_viewcode.py +++ b/tests/test_ext_viewcode.py @@ -1,5 +1,4 @@ -"""Test sphinx.ext.viewcode extension. -""" +"""Test sphinx.ext.viewcode extension.""" import re diff --git a/tests/test_extension.py b/tests/test_extension.py index d2cd37567..d74743cca 100644 --- a/tests/test_extension.py +++ b/tests/test_extension.py @@ -1,5 +1,4 @@ -"""Test sphinx.extension module. -""" +"""Test sphinx.extension module.""" import pytest diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index dc23116a7..92276a21c 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -1,5 +1,4 @@ -"""Test the Pygments highlighting bridge. -""" +"""Test the Pygments highlighting bridge.""" from unittest import mock diff --git a/tests/test_locale.py b/tests/test_locale.py index 99a335cff..1dcad64eb 100644 --- a/tests/test_locale.py +++ b/tests/test_locale.py @@ -1,5 +1,4 @@ -"""Test locale. -""" +"""Test locale.""" import pytest diff --git a/tests/test_markup.py b/tests/test_markup.py index 030323e90..39ad62784 100644 --- a/tests/test_markup.py +++ b/tests/test_markup.py @@ -1,5 +1,4 @@ -"""Test various Sphinx-specific markup extensions. -""" +"""Test various Sphinx-specific markup extensions.""" import re diff --git a/tests/test_metadata.py b/tests/test_metadata.py index 7cc0aa3c7..7f3199705 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1,5 +1,4 @@ -"""Test our handling of metadata in files with bibliographic metadata. -""" +"""Test our handling of metadata in files with bibliographic metadata.""" # adapted from an example of bibliographic metadata at # https://docutils.sourceforge.io/docs/user/rst/demo.txt diff --git a/tests/test_parser.py b/tests/test_parser.py index 2c9462936..86163c6ad 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -1,5 +1,4 @@ -"""Tests parsers module. -""" +"""Tests parsers module.""" from unittest.mock import Mock, patch diff --git a/tests/test_project.py b/tests/test_project.py index 1f4c4709f..40db85ef3 100644 --- a/tests/test_project.py +++ b/tests/test_project.py @@ -1,5 +1,4 @@ -"""Tests project module. -""" +"""Tests project module.""" from collections import OrderedDict diff --git a/tests/test_pycode.py b/tests/test_pycode.py index 560dbc8a2..1f9882eb9 100644 --- a/tests/test_pycode.py +++ b/tests/test_pycode.py @@ -1,5 +1,4 @@ -"""Test pycode. -""" +"""Test pycode.""" import os import sys diff --git a/tests/test_pycode_ast.py b/tests/test_pycode_ast.py index c3e256338..6143105eb 100644 --- a/tests/test_pycode_ast.py +++ b/tests/test_pycode_ast.py @@ -1,5 +1,4 @@ -"""Test pycode.ast -""" +"""Test pycode.ast""" import sys diff --git a/tests/test_pycode_parser.py b/tests/test_pycode_parser.py index cebcb97a3..5d2496ba5 100644 --- a/tests/test_pycode_parser.py +++ b/tests/test_pycode_parser.py @@ -1,5 +1,4 @@ -"""Test pycode.parser. -""" +"""Test pycode.parser.""" from sphinx.pycode.parser import Parser from sphinx.util.inspect import signature_from_str diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py index 4b79ee131..1ea85b19b 100644 --- a/tests/test_quickstart.py +++ b/tests/test_quickstart.py @@ -1,5 +1,4 @@ -"""Test the sphinx.quickstart module. -""" +"""Test the sphinx.quickstart module.""" import time from io import StringIO diff --git a/tests/test_roles.py b/tests/test_roles.py index 70762f48e..67a13c8ef 100644 --- a/tests/test_roles.py +++ b/tests/test_roles.py @@ -1,5 +1,4 @@ -"""Test sphinx.roles -""" +"""Test sphinx.roles""" from unittest.mock import Mock diff --git a/tests/test_search.py b/tests/test_search.py index 0568afa8f..024e6941c 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -1,5 +1,4 @@ -"""Test the search index builder. -""" +"""Test the search index builder.""" from collections import namedtuple from io import BytesIO diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py index 95c4ae201..054912feb 100644 --- a/tests/test_setup_command.py +++ b/tests/test_setup_command.py @@ -1,5 +1,4 @@ -"""Test setup_command for distutils. -""" +"""Test setup_command for distutils.""" import os import subprocess diff --git a/tests/test_smartquotes.py b/tests/test_smartquotes.py index 6233a38e4..6cfb716e4 100644 --- a/tests/test_smartquotes.py +++ b/tests/test_smartquotes.py @@ -1,5 +1,4 @@ -"""Test smart quotes. -""" +"""Test smart quotes.""" import pytest from html5lib import HTMLParser diff --git a/tests/test_templating.py b/tests/test_templating.py index 4f1ef64ee..7a6f1f004 100644 --- a/tests/test_templating.py +++ b/tests/test_templating.py @@ -1,5 +1,4 @@ -"""Test templating. -""" +"""Test templating.""" import pytest diff --git a/tests/test_theming.py b/tests/test_theming.py index 11173fd9b..21382d84b 100644 --- a/tests/test_theming.py +++ b/tests/test_theming.py @@ -1,5 +1,4 @@ -"""Test the Theme class. -""" +"""Test the Theme class.""" import os diff --git a/tests/test_toctree.py b/tests/test_toctree.py index e4d77051f..e1afa4bb9 100644 --- a/tests/test_toctree.py +++ b/tests/test_toctree.py @@ -1,5 +1,4 @@ -"""Test the HTML builder and check output against XPath. -""" +"""Test the HTML builder and check output against XPath.""" import re import pytest diff --git a/tests/test_transforms_post_transforms.py b/tests/test_transforms_post_transforms.py index 6534dd9b4..e5ec8ad14 100644 --- a/tests/test_transforms_post_transforms.py +++ b/tests/test_transforms_post_transforms.py @@ -1,5 +1,4 @@ -"""Tests the post_transforms -""" +"""Tests the post_transforms""" import pytest from docutils import nodes diff --git a/tests/test_util.py b/tests/test_util.py index c676113f8..e93e6586c 100644 --- a/tests/test_util.py +++ b/tests/test_util.py @@ -1,5 +1,4 @@ -"""Tests util functions. -""" +"""Tests util functions.""" import os import tempfile diff --git a/tests/test_util_docstrings.py b/tests/test_util_docstrings.py index 05e7b7523..813e84e97 100644 --- a/tests/test_util_docstrings.py +++ b/tests/test_util_docstrings.py @@ -1,5 +1,4 @@ -"""Test sphinx.util.docstrings. -""" +"""Test sphinx.util.docstrings.""" from sphinx.util.docstrings import prepare_commentdoc, prepare_docstring, separate_metadata diff --git a/tests/test_util_docutils.py b/tests/test_util_docutils.py index d6f97909d..41022dd99 100644 --- a/tests/test_util_docutils.py +++ b/tests/test_util_docutils.py @@ -1,5 +1,4 @@ -"""Tests util.utils functions. -""" +"""Tests util.utils functions.""" import os diff --git a/tests/test_util_fileutil.py b/tests/test_util_fileutil.py index 11a5a8557..27f95e644 100644 --- a/tests/test_util_fileutil.py +++ b/tests/test_util_fileutil.py @@ -1,5 +1,4 @@ -"""Tests sphinx.util.fileutil functions. -""" +"""Tests sphinx.util.fileutil functions.""" from unittest import mock diff --git a/tests/test_util_i18n.py b/tests/test_util_i18n.py index ee9a640ef..bf4bdbdc6 100644 --- a/tests/test_util_i18n.py +++ b/tests/test_util_i18n.py @@ -1,5 +1,4 @@ -"""Test i18n util. -""" +"""Test i18n util.""" import datetime import os diff --git a/tests/test_util_images.py b/tests/test_util_images.py index dd0648a83..52fb5e990 100644 --- a/tests/test_util_images.py +++ b/tests/test_util_images.py @@ -1,5 +1,4 @@ -"""Test images util. -""" +"""Test images util.""" import pytest diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 3987beb24..865bd0650 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -1,5 +1,4 @@ -"""Tests util.inspect functions. -""" +"""Tests util.inspect functions.""" import ast import datetime diff --git a/tests/test_util_inventory.py b/tests/test_util_inventory.py index ce96085e3..e79602330 100644 --- a/tests/test_util_inventory.py +++ b/tests/test_util_inventory.py @@ -1,5 +1,4 @@ -"""Test inventory util functions. -""" +"""Test inventory util functions.""" import posixpath import zlib diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py index 0c2b914b0..49cd2c11e 100644 --- a/tests/test_util_logging.py +++ b/tests/test_util_logging.py @@ -1,5 +1,4 @@ -"""Test logging util. -""" +"""Test logging util.""" import codecs import os diff --git a/tests/test_util_matching.py b/tests/test_util_matching.py index 559fa7aff..ee1d3b2cb 100644 --- a/tests/test_util_matching.py +++ b/tests/test_util_matching.py @@ -1,5 +1,4 @@ -"""Tests sphinx.util.matching functions. -""" +"""Tests sphinx.util.matching functions.""" from sphinx.util.matching import Matcher, compile_matchers diff --git a/tests/test_util_nodes.py b/tests/test_util_nodes.py index d73929b9c..031569d4c 100644 --- a/tests/test_util_nodes.py +++ b/tests/test_util_nodes.py @@ -1,5 +1,4 @@ -"""Tests uti.nodes functions. -""" +"""Tests uti.nodes functions.""" from textwrap import dedent from typing import Any diff --git a/tests/test_util_rst.py b/tests/test_util_rst.py index 61012e0af..40a2ee68b 100644 --- a/tests/test_util_rst.py +++ b/tests/test_util_rst.py @@ -1,5 +1,4 @@ -"""Tests sphinx.util.rst functions. -""" +"""Tests sphinx.util.rst functions.""" from docutils.statemachine import StringList from jinja2 import Environment diff --git a/tests/test_util_template.py b/tests/test_util_template.py index c2f896968..4601179c1 100644 --- a/tests/test_util_template.py +++ b/tests/test_util_template.py @@ -1,5 +1,4 @@ -"""Tests sphinx.util.template functions. -""" +"""Tests sphinx.util.template functions.""" from sphinx.util.template import ReSTRenderer diff --git a/tests/test_util_typing.py b/tests/test_util_typing.py index cf6ef0ebf..af2e5285b 100644 --- a/tests/test_util_typing.py +++ b/tests/test_util_typing.py @@ -1,5 +1,4 @@ -"""Tests util.typing functions. -""" +"""Tests util.typing functions.""" import sys from numbers import Integral diff --git a/tests/test_versioning.py b/tests/test_versioning.py index e32290aad..107e21560 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -1,5 +1,4 @@ -"""Test the versioning implementation. -""" +"""Test the versioning implementation.""" import pickle diff --git a/tests/test_writer_latex.py b/tests/test_writer_latex.py index f68694e4e..d51879949 100644 --- a/tests/test_writer_latex.py +++ b/tests/test_writer_latex.py @@ -1,5 +1,4 @@ -"""Test the LaTeX writer -""" +"""Test the LaTeX writer""" import pytest diff --git a/utils/checks.py b/utils/checks.py index aa1f2f206..3143357c2 100644 --- a/utils/checks.py +++ b/utils/checks.py @@ -1,5 +1,4 @@ -"""Custom, Sphinx-only flake8 plugins. -""" +"""Custom, Sphinx-only flake8 plugins.""" import os import re diff --git a/utils/doclinter.py b/utils/doclinter.py index 544f9952b..6ef8cbe10 100644 --- a/utils/doclinter.py +++ b/utils/doclinter.py @@ -1,5 +1,4 @@ -"""A linter for Sphinx docs -""" +"""A linter for Sphinx docs""" import os import re From 51c6642ec24ae56f9c8c5aba6aa03eba12fa7aa4 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 03:13:19 +0000 Subject: [PATCH 7/9] Remove redundant `sphinx/utils/checks.py` --- setup.cfg | 6 --- utils/checks.py | 100 ------------------------------------------------ 2 files changed, 106 deletions(-) delete mode 100644 utils/checks.py diff --git a/setup.cfg b/setup.cfg index 14b071a9e..14ca19525 100644 --- a/setup.cfg +++ b/setup.cfg @@ -35,12 +35,6 @@ import-order-style = smarkets per-file-ignores = tests/*: E501 -[flake8:local-plugins] -extension = - X101 = utils.checks:sphinx_has_header -paths = - . - [isort] line_length = 95 diff --git a/utils/checks.py b/utils/checks.py deleted file mode 100644 index 3143357c2..000000000 --- a/utils/checks.py +++ /dev/null @@ -1,100 +0,0 @@ -"""Custom, Sphinx-only flake8 plugins.""" - -import os -import re - -import sphinx - -name_mail_re = r'[\w ]+(<.*?>)?' -copyright_re = re.compile(r'^ :copyright: Copyright 200\d(-20\d\d)? ' - r'by %s(, %s)*[,.]$' % (name_mail_re, name_mail_re)) -copyright_2_re = re.compile(r'^ %s(, %s)*[,.]$' % - (name_mail_re, name_mail_re)) -license_re = re.compile(r' :license: (.*?).\n') - - -def flake8ext(_func): - """Decorate flake8_asserts functions""" - _func.name = _func.__name__ - _func.version = sphinx.__version__ - _func.code = _func.__name__.upper() - - return _func - - -@flake8ext -def sphinx_has_header(physical_line, filename, lines, line_number): - """Check for correct headers. - - Make sure each Python file has a correct file header including - copyright and license information. - - X101 invalid header found - """ - # we have a state machine of sorts so we need to start on line 1. Also, - # there's no point checking really short files - if line_number != 1 or len(lines) < 10: - return - - # this file uses a funky license but unfortunately it's not possible to - # ignore specific errors on a file-level basis yet [1]. Simply skip it. - # - # [1] https://gitlab.com/pycqa/flake8/issues/347 - if os.path.samefile(filename, './sphinx/util/smartypants.py'): - return - - # if the top-level package or not inside the package, ignore - mod_name = os.path.splitext(filename)[0].strip('./\\').replace( - '/', '.').replace('.__init__', '') - if mod_name == 'sphinx' or not mod_name.startswith('sphinx.'): - return - - # line number correction - offset = 1 - if lines[0:1] == ['#!/usr/bin/env python3\n']: - lines = lines[1:] - offset = 2 - - llist = [] - doc_open = False - - for lno, line in enumerate(lines): - llist.append(line) - if lno == 0: - if line != '"""\n' and line != 'r"""\n': - return 0, 'X101 missing docstring begin (""")' - else: - doc_open = True - elif doc_open: - if line == '"""\n': - # end of docstring - if lno <= 3: - return 0, 'X101 missing module name in docstring' - break - - if line != '\n' and line[:4] != ' ' and doc_open: - return 0, 'X101 missing correct docstring indentation' - - if lno == 1: - mod_name_len = len(line.strip()) - if line.strip() != mod_name: - return 2, 'X101 wrong module name in docstring heading' - elif lno == 2: - if line.strip() != mod_name_len * '~': - return (3, 'X101 wrong module name underline, should be ' - '~~~...~') - else: - return 0, 'X101 missing end and/or start of docstring...' - - # check for copyright and license fields - license = llist[-2:-1] - if not license or not license_re.match(license[0]): - return 0, 'X101 no correct license info' - - offset = -3 - copyright = llist[offset:offset + 1] - while copyright and copyright_2_re.match(copyright[0]): - offset -= 1 - copyright = llist[offset:offset + 1] - if not copyright or not copyright_re.match(copyright[0]): - return 0, 'X101 no correct copyright info' From f05d455313d2a521723f8f99f30b86a86fce1d4c Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 03:19:55 +0000 Subject: [PATCH 8/9] Add catch-all text to LICENSE --- LICENSE | 3 +++ 1 file changed, 3 insertions(+) diff --git a/LICENSE b/LICENSE index 021d9dbdc..05bf4ab2d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,9 @@ License for Sphinx ================== +Unless otherwise indicated, all code in the Sphinx project is licenced under the +two clause BSD licence below. + Copyright (c) 2007-2022 by the Sphinx team (see AUTHORS file). All rights reserved. From f05a068be980b7f237135596c9414e4737052681 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Mon, 7 Mar 2022 15:17:45 +0000 Subject: [PATCH 9/9] Fix whitespace --- sphinx/ext/napoleon/docstring.py | 6 +----- sphinx/ext/napoleon/iterators.py | 6 +----- tests/test_ext_napoleon.py | 4 +--- tests/test_ext_napoleon_docstring.py | 4 +--- tests/test_ext_napoleon_iterators.py | 4 +--- 5 files changed, 5 insertions(+), 19 deletions(-) diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index c80baecba..a11424537 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -1,8 +1,4 @@ -""" - -Classes for docstring parsing and formatting. - -""" +"""Classes for docstring parsing and formatting.""" import collections import inspect diff --git a/sphinx/ext/napoleon/iterators.py b/sphinx/ext/napoleon/iterators.py index bebd56518..9459ad4a6 100644 --- a/sphinx/ext/napoleon/iterators.py +++ b/sphinx/ext/napoleon/iterators.py @@ -1,8 +1,4 @@ -""" - -A collection of helpful iterators. - -""" +"""A collection of helpful iterators.""" import collections from typing import Any, Iterable, Optional diff --git a/tests/test_ext_napoleon.py b/tests/test_ext_napoleon.py index bcc0d6d23..a1b98996f 100644 --- a/tests/test_ext_napoleon.py +++ b/tests/test_ext_napoleon.py @@ -1,6 +1,4 @@ -"""Tests for :mod:`sphinx.ext.napoleon.__init__` module. - -""" +"""Tests for :mod:`sphinx.ext.napoleon.__init__` module.""" import sys from collections import namedtuple diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index 514276061..ed97b6351 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -1,6 +1,4 @@ -"""Tests for :mod:`sphinx.ext.napoleon.docstring` module. - -""" +"""Tests for :mod:`sphinx.ext.napoleon.docstring` module.""" import re import sys diff --git a/tests/test_ext_napoleon_iterators.py b/tests/test_ext_napoleon_iterators.py index e9684521e..6b80af6bf 100644 --- a/tests/test_ext_napoleon_iterators.py +++ b/tests/test_ext_napoleon_iterators.py @@ -1,6 +1,4 @@ -"""Tests for :mod:`sphinx.ext.napoleon.iterators` module. - -""" +"""Tests for :mod:`sphinx.ext.napoleon.iterators` module.""" from unittest import TestCase