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] 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 = """