diff options
270 files changed, 270 insertions, 540 deletions
diff --git a/sphinx/__init__.py b/sphinx/__init__.py index 197d678c9..656f0bf39 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -1,5 +1,4 @@ -""" - The Sphinx documentation toolchain. +"""The Sphinx documentation toolchain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/__main__.py b/sphinx/__main__.py index 2d750a0c2..8897f3231 100644 --- a/sphinx/__main__.py +++ b/sphinx/__main__.py @@ -1,5 +1,4 @@ -""" - The Sphinx documentation toolchain. +"""The Sphinx documentation toolchain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index 5f0ea74ee..d2af6aa32 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -1,5 +1,4 @@ -""" - Additional docutils nodes. +"""Additional docutils nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/application.py b/sphinx/application.py index 640c14e4e..d060d3e35 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -1,5 +1,4 @@ -""" - Sphinx application class and extensibility interface. +"""Sphinx application class and extensibility interface. Gracefully adapted from the TextPress system by Armin. diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index 0fd3649a2..e1f0ad4ec 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -1,5 +1,4 @@ -""" - Builder superclass for all builders. +"""Builder superclass for all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index 1bdaf39ea..099be31b4 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -1,5 +1,4 @@ -""" - Base class of epub2/epub3 builders. +"""Base class of epub2/epub3 builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index 84ea55f0d..37b1afb1a 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -1,5 +1,4 @@ -""" - Changelog builder. +"""Changelog builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/dirhtml.py b/sphinx/builders/dirhtml.py index 5e9218d3f..9ffe634fe 100644 --- a/sphinx/builders/dirhtml.py +++ b/sphinx/builders/dirhtml.py @@ -1,5 +1,4 @@ -""" - Directory HTML builders. +"""Directory HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/dummy.py b/sphinx/builders/dummy.py index 083bde2f9..b1d5414df 100644 --- a/sphinx/builders/dummy.py +++ b/sphinx/builders/dummy.py @@ -1,5 +1,4 @@ -""" - Do syntax checks, but no writing. +"""Do syntax checks, but no writing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/epub3.py b/sphinx/builders/epub3.py index 9f204db2c..c7a9cb164 100644 --- a/sphinx/builders/epub3.py +++ b/sphinx/builders/epub3.py @@ -1,5 +1,4 @@ -""" - Build epub3 files. +"""Build epub3 files. Originally derived from epub.py. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index d07a89575..16d49f25d 100644 --- a/sphinx/builders/gettext.py +++ b/sphinx/builders/gettext.py @@ -1,5 +1,4 @@ -""" - The MessageCatalogBuilder class. +"""The MessageCatalogBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py index e6c5ea5ae..56008e474 100644 --- a/sphinx/builders/html/__init__.py +++ b/sphinx/builders/html/__init__.py @@ -1,5 +1,4 @@ -""" - Several HTML builders. +"""Several HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/html/transforms.py b/sphinx/builders/html/transforms.py index 3f36c195d..f8671dcec 100644 --- a/sphinx/builders/html/transforms.py +++ b/sphinx/builders/html/transforms.py @@ -1,5 +1,4 @@ -""" - Transforms for HTML builder. +"""Transforms for HTML builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index 78063eee4..ba71eba64 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -1,5 +1,4 @@ -""" - LaTeX builder. +"""LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py index 1e939a46c..ace27d6a7 100644 --- a/sphinx/builders/latex/constants.py +++ b/sphinx/builders/latex/constants.py @@ -1,5 +1,4 @@ -""" - consntants for LaTeX builder. +"""consntants for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/nodes.py b/sphinx/builders/latex/nodes.py index 30c729941..51fed2a9b 100644 --- a/sphinx/builders/latex/nodes.py +++ b/sphinx/builders/latex/nodes.py @@ -1,5 +1,4 @@ -""" - Additional nodes for LaTeX writer. +"""Additional nodes for LaTeX writer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/theming.py b/sphinx/builders/latex/theming.py index a465cb209..434688841 100644 --- a/sphinx/builders/latex/theming.py +++ b/sphinx/builders/latex/theming.py @@ -1,5 +1,4 @@ -""" - Theming support for LaTeX builder. +"""Theming support for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py index 3309b891d..0dbaed100 100644 --- a/sphinx/builders/latex/transforms.py +++ b/sphinx/builders/latex/transforms.py @@ -1,5 +1,4 @@ -""" - Transforms for LaTeX builder. +"""Transforms for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/latex/util.py b/sphinx/builders/latex/util.py index da1f79653..34fff7fcc 100644 --- a/sphinx/builders/latex/util.py +++ b/sphinx/builders/latex/util.py @@ -1,5 +1,4 @@ -""" - Utilities for LaTeX builder. +"""Utilities for LaTeX builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index e6621a254..036b26836 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -1,5 +1,4 @@ -""" - The CheckExternalLinksBuilder class. +"""The CheckExternalLinksBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index 59870809e..76772d873 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -1,5 +1,4 @@ -""" - Manual pages builder. +"""Manual pages builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py index 0c4daf8a4..0d65a0bcd 100644 --- a/sphinx/builders/singlehtml.py +++ b/sphinx/builders/singlehtml.py @@ -1,5 +1,4 @@ -""" - Single HTML builders. +"""Single HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index 56448b638..431cec29e 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -1,5 +1,4 @@ -""" - Texinfo builder. +"""Texinfo builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index 038ae4ba0..4f400f577 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -1,5 +1,4 @@ -""" - Plain-text Sphinx builder. +"""Plain-text Sphinx builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py index 873cc34d5..d3701f00a 100644 --- a/sphinx/builders/xml.py +++ b/sphinx/builders/xml.py @@ -1,5 +1,4 @@ -""" - Docutils-native XML and pseudo-XML builders. +"""Docutils-native XML and pseudo-XML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/cmd/__init__.py b/sphinx/cmd/__init__.py index 717893f69..2ef622e26 100644 --- a/sphinx/cmd/__init__.py +++ b/sphinx/cmd/__init__.py @@ -1,5 +1,4 @@ -""" - Modules for command line executables. +"""Modules for command line executables. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index e135cf385..16c9a6274 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -1,5 +1,4 @@ -""" - Build documentation from a provided source. +"""Build documentation from a provided source. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/cmd/make_mode.py b/sphinx/cmd/make_mode.py index a08b673ad..c8e694954 100644 --- a/sphinx/cmd/make_mode.py +++ b/sphinx/cmd/make_mode.py @@ -1,5 +1,4 @@ -""" - sphinx-build -M command-line handling. +"""sphinx-build -M command-line handling. This replaces the old, platform-dependent and once-generated content of Makefile / make.bat. diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index c5e3ebb52..addb4c621 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -1,5 +1,4 @@ -""" - Quickly setup documentation source to work with Sphinx. +"""Quickly setup documentation source to work with Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/config.py b/sphinx/config.py index 32daedcec..eabc79425 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -1,5 +1,4 @@ -""" - Build configuration file handling. +"""Build configuration file handling. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py index 10ff34658..7ee5b1773 100644 --- a/sphinx/deprecation.py +++ b/sphinx/deprecation.py @@ -1,5 +1,4 @@ -""" - Sphinx deprecation classes and utilities. +"""Sphinx deprecation classes and utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index 1b4a992b9..5bd57d9cd 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -1,5 +1,4 @@ -""" - Handlers for additional ReST directives. +"""Handlers for additional ReST directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py index 6e702b86e..6942def51 100644 --- a/sphinx/domains/__init__.py +++ b/sphinx/domains/__init__.py @@ -1,5 +1,4 @@ -""" - Support for domains, which are groupings of description directives +"""Support for domains, which are groupings of description directives and roles describing e.g. constructs of one programming language. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index c79173e01..41742a624 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -1,5 +1,4 @@ -""" - The C language domain. +"""The C language domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index 817f35487..91cf7412f 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -1,5 +1,4 @@ -""" - The changeset domain. +"""The changeset domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/citation.py b/sphinx/domains/citation.py index a3b5bc04b..897d5b46a 100644 --- a/sphinx/domains/citation.py +++ b/sphinx/domains/citation.py @@ -1,5 +1,4 @@ -""" - The citation domain. +"""The citation domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index a9fe0d967..7d4b19db8 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1,5 +1,4 @@ -""" - The C++ language domain. +"""The C++ language domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/index.py b/sphinx/domains/index.py index 961b590f4..e5ca1fa11 100644 --- a/sphinx/domains/index.py +++ b/sphinx/domains/index.py @@ -1,5 +1,4 @@ -""" - The index domain. +"""The index domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 5c30c2180..68303d8eb 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -1,5 +1,4 @@ -""" - The JavaScript domain. +"""The JavaScript domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py index f4db6a6b7..ce7df96a1 100644 --- a/sphinx/domains/math.py +++ b/sphinx/domains/math.py @@ -1,5 +1,4 @@ -""" - The math domain. +"""The math domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index e927b959d..6cd7af93c 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -1,5 +1,4 @@ -""" - The Python domain. +"""The Python domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py index 40f69dee3..549818d03 100644 --- a/sphinx/domains/rst.py +++ b/sphinx/domains/rst.py @@ -1,5 +1,4 @@ -""" - The reStructuredText domain. +"""The reStructuredText domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index 8187abd4b..b0a2e6bfc 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -1,5 +1,4 @@ -""" - The standard domain. +"""The standard domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index bbe4bf2b7..df75296f6 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -1,5 +1,4 @@ -""" - Global creation environment. +"""Global creation environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/adapters/__init__.py b/sphinx/environment/adapters/__init__.py index 2fd847357..3df72b665 100644 --- a/sphinx/environment/adapters/__init__.py +++ b/sphinx/environment/adapters/__init__.py @@ -1,5 +1,4 @@ -""" - Sphinx environment adapters +"""Sphinx environment adapters :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/adapters/asset.py b/sphinx/environment/adapters/asset.py index 63e736ff7..a633d4e5d 100644 --- a/sphinx/environment/adapters/asset.py +++ b/sphinx/environment/adapters/asset.py @@ -1,5 +1,4 @@ -""" - Assets adapter for sphinx.environment. +"""Assets adapter for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/adapters/indexentries.py b/sphinx/environment/adapters/indexentries.py index 28d56e1c8..66689ab91 100644 --- a/sphinx/environment/adapters/indexentries.py +++ b/sphinx/environment/adapters/indexentries.py @@ -1,5 +1,4 @@ -""" - Index entries adapters for sphinx.environment. +"""Index entries adapters for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index 1c27fa705..6186f6f1d 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/sphinx/environment/adapters/toctree.py @@ -1,5 +1,4 @@ -""" - Toctree adapter for sphinx.environment. +"""Toctree adapter for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/__init__.py b/sphinx/environment/collectors/__init__.py index badc0bac0..6126a883f 100644 --- a/sphinx/environment/collectors/__init__.py +++ b/sphinx/environment/collectors/__init__.py @@ -1,5 +1,4 @@ -""" - The data collector components for sphinx.environment. +"""The data collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/asset.py b/sphinx/environment/collectors/asset.py index fd51061b9..d98bfde53 100644 --- a/sphinx/environment/collectors/asset.py +++ b/sphinx/environment/collectors/asset.py @@ -1,5 +1,4 @@ -""" - The image collector for sphinx.environment. +"""The image collector for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/dependencies.py b/sphinx/environment/collectors/dependencies.py index d1ce80a73..0512e6fd4 100644 --- a/sphinx/environment/collectors/dependencies.py +++ b/sphinx/environment/collectors/dependencies.py @@ -1,5 +1,4 @@ -""" - The dependencies collector components for sphinx.environment. +"""The dependencies collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/metadata.py b/sphinx/environment/collectors/metadata.py index 34bfb49cd..67172b973 100644 --- a/sphinx/environment/collectors/metadata.py +++ b/sphinx/environment/collectors/metadata.py @@ -1,5 +1,4 @@ -""" - The metadata collector components for sphinx.environment. +"""The metadata collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/title.py b/sphinx/environment/collectors/title.py index 1ef53514d..df875d0e2 100644 --- a/sphinx/environment/collectors/title.py +++ b/sphinx/environment/collectors/title.py @@ -1,5 +1,4 @@ -""" - The title collector components for sphinx.environment. +"""The title collector components for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/environment/collectors/toctree.py b/sphinx/environment/collectors/toctree.py index dc39ee254..c53ee6129 100644 --- a/sphinx/environment/collectors/toctree.py +++ b/sphinx/environment/collectors/toctree.py @@ -1,5 +1,4 @@ -""" - Toctree collector for sphinx.environment. +"""Toctree collector for sphinx.environment. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/errors.py b/sphinx/errors.py index f89804c7f..e0aab4b05 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,5 +1,4 @@ -""" - Contains SphinxError and a few subclasses (in an extra module to avoid +"""Contains SphinxError and a few subclasses (in an extra module to avoid circular import problems). :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/events.py b/sphinx/events.py index 5a95416fc..cb4d1f7d2 100644 --- a/sphinx/events.py +++ b/sphinx/events.py @@ -1,5 +1,4 @@ -""" - Sphinx core events. +"""Sphinx core events. Gracefully adapted from the TextPress system by Armin. diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py index a97bab5bf..4d293c049 100644 --- a/sphinx/ext/__init__.py +++ b/sphinx/ext/__init__.py @@ -1,5 +1,4 @@ -""" - Contains Sphinx features not activated by default. +"""Contains Sphinx features not activated by default. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py index bb1e582eb..c6ad9e984 100644 --- a/sphinx/ext/apidoc.py +++ b/sphinx/ext/apidoc.py @@ -1,5 +1,4 @@ -""" - Parses a directory tree looking for Python modules and packages and creates +"""Parses a directory tree looking for Python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index (named modules.<suffix>). diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 6d19e6eee..69dc1533a 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1,5 +1,4 @@ -""" - Automatically insert docstrings for functions, classes or whole modules into +"""Automatically insert docstrings for functions, classes or whole modules into the doctree, thus avoiding duplication between docstrings and documentation for those who like elaborate docstrings. diff --git a/sphinx/ext/autodoc/deprecated.py b/sphinx/ext/autodoc/deprecated.py index 63e2c307b..740c87b80 100644 --- a/sphinx/ext/autodoc/deprecated.py +++ b/sphinx/ext/autodoc/deprecated.py @@ -1,5 +1,4 @@ -""" - The deprecated Documenters for autodoc. +"""The deprecated Documenters for autodoc. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py index dfa088f2a..3f4810a14 100644 --- a/sphinx/ext/autodoc/importer.py +++ b/sphinx/ext/autodoc/importer.py @@ -1,5 +1,4 @@ -""" - Importer utilities for autodoc +"""Importer utilities for autodoc :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py index 759c5bae1..aafb3f8c2 100644 --- a/sphinx/ext/autodoc/mock.py +++ b/sphinx/ext/autodoc/mock.py @@ -1,5 +1,4 @@ -""" - mock for autodoc +"""mock for autodoc :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autodoc/preserve_defaults.py b/sphinx/ext/autodoc/preserve_defaults.py index 9b5d76204..8cde4d08f 100644 --- a/sphinx/ext/autodoc/preserve_defaults.py +++ b/sphinx/ext/autodoc/preserve_defaults.py @@ -1,5 +1,4 @@ -""" - Preserve the default argument values of function signatures in source code +"""Preserve the default argument values of function signatures in source code and keep them not evaluated for readability. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/autodoc/type_comment.py b/sphinx/ext/autodoc/type_comment.py index e4483842d..f8cfa334a 100644 --- a/sphinx/ext/autodoc/type_comment.py +++ b/sphinx/ext/autodoc/type_comment.py @@ -1,5 +1,4 @@ -""" - Update annotations info of living objects using type_comments. +"""Update annotations info of living objects using type_comments. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py index 6b4188d22..ccdbfb2b0 100644 --- a/sphinx/ext/autodoc/typehints.py +++ b/sphinx/ext/autodoc/typehints.py @@ -1,5 +1,4 @@ -""" - Generating content for autodoc using typehints +"""Generating content for autodoc using typehints :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py index 944d2d4cc..5341248fc 100644 --- a/sphinx/ext/autosectionlabel.py +++ b/sphinx/ext/autosectionlabel.py @@ -1,5 +1,4 @@ -""" - Allow reference sections by :ref: role using its title. +"""Allow reference sections by :ref: role using its title. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index c18a71d70..1c7bce8cd 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -1,5 +1,4 @@ -""" - Sphinx extension that adds an autosummary:: directive, which can be +"""Sphinx extension that adds an autosummary:: directive, which can be used to generate function/method/attribute/etc. summary lists, similar to those output eg. by Epydoc and other API doc generation tools. diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index ff67a25e8..00f343da8 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -1,5 +1,4 @@ -""" - Usable as a library or script to generate automatic RST source files for +"""Usable as a library or script to generate automatic RST source files for items referred to in autosummary:: directives. Each generated RST file contains a single auto*:: directive which diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index 652bc5c0f..6fd1b1fdc 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -1,5 +1,4 @@ -""" - Check Python modules and C API for coverage. Mostly written by Josip +"""Check Python modules and C API for coverage. Mostly written by Josip Dzolonga for the Google Highly Open Participation contest. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index af6da43e0..94082e78c 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -1,5 +1,4 @@ -""" - Mimic doctest by automatically executing code snippets and checking +"""Mimic doctest by automatically executing code snippets and checking their results. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py index 6e918b134..8e624f24c 100644 --- a/sphinx/ext/duration.py +++ b/sphinx/ext/duration.py @@ -1,5 +1,4 @@ -""" - Measure durations of Sphinx processing. +"""Measure durations of Sphinx processing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py index 58ed9674b..ba886b837 100644 --- a/sphinx/ext/extlinks.py +++ b/sphinx/ext/extlinks.py @@ -1,5 +1,4 @@ -""" - Extension to save typing and prevent hard-coding of base URLs in the reST +"""Extension to save typing and prevent hard-coding of base URLs in the reST files. This adds a new config value called ``extlinks`` that is created like this:: diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py index cb2584d8d..a59fde913 100644 --- a/sphinx/ext/githubpages.py +++ b/sphinx/ext/githubpages.py @@ -1,5 +1,4 @@ -""" - To publish HTML docs at GitHub Pages, create .nojekyll file. +"""To publish HTML docs at GitHub Pages, create .nojekyll file. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index e5749d143..6e2e8958d 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -1,5 +1,4 @@ -""" - Allow graphviz-formatted graphs to be included in Sphinx-generated +"""Allow graphviz-formatted graphs to be included in Sphinx-generated documents inline. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 44f218f3d..f46241409 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -1,5 +1,4 @@ -""" - Provides the ``ifconfig`` directive that allows to write documentation +"""Provides the ``ifconfig`` directive that allows to write documentation that is included depending on configuration variables. Usage:: diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index 2117e7130..e5582de4b 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -1,5 +1,4 @@ -""" - Image converter extension for Sphinx +"""Image converter extension for Sphinx :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index bdabc8634..47ba9d927 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -1,5 +1,4 @@ -""" - Render math in HTML via dvipng or dvisvgm. +"""Render math in HTML via dvipng or dvisvgm. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index e1fd2a237..1afd6c5ab 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -1,5 +1,4 @@ -r""" - Defines a docutils directive for inserting inheritance diagrams. +r"""Defines a docutils directive for inserting inheritance diagrams. Provide the directive with one or more classes or modules (separated by whitespace). For modules, all of the classes in that module will diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index eacc72f85..ad27fd4cf 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -1,5 +1,4 @@ -""" - Insert links to objects documented in remote Sphinx documentation. +"""Insert links to objects documented in remote Sphinx documentation. This works as follows: diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index d724e3551..2f6c73846 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -1,5 +1,4 @@ -""" - Add external links to module code in Python object descriptions. +"""Add external links to module code in Python object descriptions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index c641b11ea..d2c7affcb 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -1,5 +1,4 @@ -""" - Allow `MathJax <https://www.mathjax.org/>`_ to be used to display math in +"""Allow `MathJax <https://www.mathjax.org/>`_ to be used to display math in Sphinx's HTML writer -- requires the MathJax JavaScript library on your webserver/computer. diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index 07e165ec6..cc1ec3638 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -1,5 +1,4 @@ -""" - Support for NumPy and Google style docstrings. +"""Support for NumPy and Google style docstrings. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index 7c1df2c69..4e06aee5a 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -1,5 +1,4 @@ -""" - Allow todos to be inserted into your documentation. Inclusion of todos can +"""Allow todos to be inserted into your documentation. Inclusion of todos can be switched of by a configuration variable. The todolist directive collects all todos of your project and lists them along with a backlink to the original location. diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 5fd6120c0..fb6b3df10 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -1,5 +1,4 @@ -""" - Add links to module code in Python object descriptions. +"""Add links to module code in Python object descriptions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/extension.py b/sphinx/extension.py index 0188dab17..584ce6add 100644 --- a/sphinx/extension.py +++ b/sphinx/extension.py @@ -1,5 +1,4 @@ -""" - Utilities for Sphinx extensions. +"""Utilities for Sphinx extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 37e1cdf17..3580b3efb 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -1,5 +1,4 @@ -""" - Highlight code blocks using Pygments. +"""Highlight code blocks using Pygments. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/io.py b/sphinx/io.py index 7d8bd87a9..63c04168e 100644 --- a/sphinx/io.py +++ b/sphinx/io.py @@ -1,5 +1,4 @@ -""" - Input/Output files +"""Input/Output files :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index c61ad8cf8..dbc5cab8b 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -1,5 +1,4 @@ -""" - Glue code for the jinja2 templating engine. +"""Glue code for the jinja2 templating engine. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py index b0e579d3b..dabba8519 100644 --- a/sphinx/locale/__init__.py +++ b/sphinx/locale/__init__.py @@ -1,5 +1,4 @@ -""" - Locale utilities. +"""Locale utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/parsers.py b/sphinx/parsers.py index 471c27274..ee1be5b10 100644 --- a/sphinx/parsers.py +++ b/sphinx/parsers.py @@ -1,5 +1,4 @@ -""" - A Base class for additional parsers. +"""A Base class for additional parsers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/project.py b/sphinx/project.py index 47559d7b8..c8d7fc9dd 100644 --- a/sphinx/project.py +++ b/sphinx/project.py @@ -1,5 +1,4 @@ -""" - Utility function and classes for Sphinx projects. +"""Utility function and classes for Sphinx projects. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index 66f506795..0188e9bcb 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -1,5 +1,4 @@ -""" - Utilities parsing and analyzing Python code. +"""Utilities parsing and analyzing Python code. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py index 07c85bf11..8c8f65d8b 100644 --- a/sphinx/pycode/ast.py +++ b/sphinx/pycode/ast.py @@ -1,5 +1,4 @@ -""" - Helpers for AST (Abstract Syntax Tree). +"""Helpers for AST (Abstract Syntax Tree). :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py index 2265dd2ac..e47b229a1 100644 --- a/sphinx/pycode/parser.py +++ b/sphinx/pycode/parser.py @@ -1,5 +1,4 @@ -""" - Utilities parsing and analyzing Python code. +"""Utilities parsing and analyzing Python code. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py index 37bd872bc..ac3556194 100644 --- a/sphinx/pygments_styles.py +++ b/sphinx/pygments_styles.py @@ -1,5 +1,4 @@ -""" - Sphinx theme specific highlighting styles. +"""Sphinx theme specific highlighting styles. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/registry.py b/sphinx/registry.py index e928bb4db..59638c9a1 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -1,5 +1,4 @@ -""" - Sphinx component registry. +"""Sphinx component registry. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/roles.py b/sphinx/roles.py index 177b7c61b..4c8fa2c8a 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -1,5 +1,4 @@ -""" - Handlers for additional ReST roles. +"""Handlers for additional ReST roles. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index c569aa797..15fffd003 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -1,5 +1,4 @@ -""" - Create a full-text search index for offline search. +"""Create a full-text search index for offline search. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/da.py b/sphinx/search/da.py index 275555136..de20b45d4 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -1,5 +1,4 @@ -""" - Danish search language: includes the JS Danish stemmer. +"""Danish search language: includes the JS Danish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/de.py b/sphinx/search/de.py index af02d12dd..05b3eeaee 100644 --- a/sphinx/search/de.py +++ b/sphinx/search/de.py @@ -1,5 +1,4 @@ -""" - German search language: includes the JS German stemmer. +"""German search language: includes the JS German stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/en.py b/sphinx/search/en.py index c6667c530..b6e4b31ed 100644 --- a/sphinx/search/en.py +++ b/sphinx/search/en.py @@ -1,5 +1,4 @@ -""" - English search language: includes the JS porter stemmer. +"""English search language: includes the JS porter stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/es.py b/sphinx/search/es.py index 3026c9fd4..1bee7fbf7 100644 --- a/sphinx/search/es.py +++ b/sphinx/search/es.py @@ -1,5 +1,4 @@ -""" - Spanish search language: includes the JS Spanish stemmer. +"""Spanish search language: includes the JS Spanish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py index bda7159f0..a632ad647 100644 --- a/sphinx/search/fi.py +++ b/sphinx/search/fi.py @@ -1,5 +1,4 @@ -""" - Finnish search language: includes the JS Finnish stemmer. +"""Finnish search language: includes the JS Finnish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py index 4692a64e3..19be35946 100644 --- a/sphinx/search/fr.py +++ b/sphinx/search/fr.py @@ -1,5 +1,4 @@ -""" - French search language: includes the JS French stemmer. +"""French search language: includes the JS French stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py index 0d0c28e50..821aabcf9 100644 --- a/sphinx/search/hu.py +++ b/sphinx/search/hu.py @@ -1,5 +1,4 @@ -""" - Hungarian search language: includes the JS Hungarian stemmer. +"""Hungarian search language: includes the JS Hungarian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/it.py b/sphinx/search/it.py index 9ec7768ed..e751a17a1 100644 --- a/sphinx/search/it.py +++ b/sphinx/search/it.py @@ -1,5 +1,4 @@ -""" - Italian search language: includes the JS Italian stemmer. +"""Italian search language: includes the JS Italian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index 820de07f1..fab0595da 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -1,5 +1,4 @@ -""" - Japanese search language: includes routine to split words. +"""Japanese search language: includes routine to split words. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/jssplitter.py b/sphinx/search/jssplitter.py index 13f55a16e..c4fe62737 100644 --- a/sphinx/search/jssplitter.py +++ b/sphinx/search/jssplitter.py @@ -1,5 +1,4 @@ -""" - Provides Python compatible word splitter to JavaScript +"""Provides Python compatible word splitter to JavaScript DO NOT EDIT. This is generated by utils/jssplitter_generator.py diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py index 06c84ce4d..a7989b1ed 100644 --- a/sphinx/search/nl.py +++ b/sphinx/search/nl.py @@ -1,5 +1,4 @@ -""" - Dutch search language: includes the JS porter stemmer. +"""Dutch search language: includes the JS porter stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/no.py b/sphinx/search/no.py index 1208991cb..c30352530 100644 --- a/sphinx/search/no.py +++ b/sphinx/search/no.py @@ -1,5 +1,4 @@ -""" - Norwegian search language: includes the JS Norwegian stemmer. +"""Norwegian search language: includes the JS Norwegian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py index 46a4bb0d0..994daebe7 100644 --- a/sphinx/search/pt.py +++ b/sphinx/search/pt.py @@ -1,5 +1,4 @@ -""" - Portuguese search language: includes the JS Portuguese stemmer. +"""Portuguese search language: includes the JS Portuguese stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/ro.py b/sphinx/search/ro.py index 817c70165..bbc5e9326 100644 --- a/sphinx/search/ro.py +++ b/sphinx/search/ro.py @@ -1,5 +1,4 @@ -""" - Romanian search language: includes the JS Romanian stemmer. +"""Romanian search language: includes the JS Romanian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index f2e027592..53dd64e83 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -1,5 +1,4 @@ -""" - Russian search language: includes the JS Russian stemmer. +"""Russian search language: includes the JS Russian stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py index c7b0fde93..0ee635416 100644 --- a/sphinx/search/sv.py +++ b/sphinx/search/sv.py @@ -1,5 +1,4 @@ -""" - Swedish search language: includes the JS Swedish stemmer. +"""Swedish search language: includes the JS Swedish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/tr.py b/sphinx/search/tr.py index c85912337..75eca4731 100644 --- a/sphinx/search/tr.py +++ b/sphinx/search/tr.py @@ -1,5 +1,4 @@ -""" - Turkish search language: includes the JS Turkish stemmer. +"""Turkish search language: includes the JS Turkish stemmer. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/search/zh.py b/sphinx/search/zh.py index 276a49a70..712fdf63b 100644 --- a/sphinx/search/zh.py +++ b/sphinx/search/zh.py @@ -1,5 +1,4 @@ -""" - Chinese search language: includes routine to split words. +"""Chinese search language: includes routine to split words. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index 3d9663d0f..80914373a 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -1,5 +1,4 @@ -""" - Setuptools/distutils commands to assist the building of sphinx +"""Setuptools/distutils commands to assist the building of sphinx documentation. :author: Sebastian Wiesner diff --git a/sphinx/testing/__init__.py b/sphinx/testing/__init__.py index babfde1f5..7798e69f7 100644 --- a/sphinx/testing/__init__.py +++ b/sphinx/testing/__init__.py @@ -1,5 +1,4 @@ -""" - Sphinx test utilities +"""Sphinx test utilities You can require sphinx.testing pytest fixtures in a test module or a conftest file like this: diff --git a/sphinx/testing/comparer.py b/sphinx/testing/comparer.py index 577a4d091..e102a52c9 100644 --- a/sphinx/testing/comparer.py +++ b/sphinx/testing/comparer.py @@ -1,5 +1,4 @@ -""" - Sphinx test comparer for pytest +"""Sphinx test comparer for pytest :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py index 69233707c..15ecfb39c 100644 --- a/sphinx/testing/fixtures.py +++ b/sphinx/testing/fixtures.py @@ -1,5 +1,4 @@ -""" - Sphinx test fixtures for pytest +"""Sphinx test fixtures for pytest :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py index 197e802ed..a1b4b8601 100644 --- a/sphinx/testing/util.py +++ b/sphinx/testing/util.py @@ -1,5 +1,4 @@ -""" - Sphinx test suite utilities +"""Sphinx test suite utilities :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/theming.py b/sphinx/theming.py index c4cfad77a..1931424d8 100644 --- a/sphinx/theming.py +++ b/sphinx/theming.py @@ -1,5 +1,4 @@ -""" - Theming support for HTML builders. +"""Theming support for HTML builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py index ab23f7b4e..60d1c2436 100644 --- a/sphinx/transforms/__init__.py +++ b/sphinx/transforms/__init__.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx when reading documents. +"""Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py index c1dfee0d8..7bcdb515c 100644 --- a/sphinx/transforms/compact_bullet_list.py +++ b/sphinx/transforms/compact_bullet_list.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx when reading documents. +"""Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py index 6a80daf08..62e75fa24 100644 --- a/sphinx/transforms/i18n.py +++ b/sphinx/transforms/i18n.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx when reading documents. +"""Docutils transforms used by Sphinx when reading documents. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py index 720807118..5595ad4b7 100644 --- a/sphinx/transforms/post_transforms/__init__.py +++ b/sphinx/transforms/post_transforms/__init__.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx. +"""Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index 0deda5ed0..3af3b21c7 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -1,5 +1,4 @@ -""" - transforms for code-blocks. +"""transforms for code-blocks. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py index 6c265a470..d7149c0c2 100644 --- a/sphinx/transforms/post_transforms/images.py +++ b/sphinx/transforms/post_transforms/images.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx. +"""Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py index b47fb545b..ed7a0b472 100644 --- a/sphinx/transforms/references.py +++ b/sphinx/transforms/references.py @@ -1,5 +1,4 @@ -""" - Docutils transforms used by Sphinx. +"""Docutils transforms used by Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 554ade0cb..d6454735d 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -1,5 +1,4 @@ -""" - Utility functions for Sphinx. +"""Utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py index 68cdb6a31..4f7bf1a75 100644 --- a/sphinx/util/build_phase.py +++ b/sphinx/util/build_phase.py @@ -1,5 +1,4 @@ -""" - Build phase of Sphinx application. +"""Build phase of Sphinx application. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py index 6b9b05966..0772bee20 100644 --- a/sphinx/util/cfamily.py +++ b/sphinx/util/cfamily.py @@ -1,5 +1,4 @@ -""" - Utility functions common to the C and C++ domains. +"""Utility functions common to the C and C++ domains. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 0f644b838..8d5eed46e 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -1,5 +1,4 @@ -""" - modules for backward compatibility +"""modules for backward compatibility :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/console.py b/sphinx/util/console.py index 62e4d297e..b391d524b 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -1,5 +1,4 @@ -""" - Format colored console output. +"""Format colored console output. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index f81f80948..adabab9c8 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -1,5 +1,4 @@ -""" - "Doc fields" are reST field lists in object descriptions that will +""""Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index f634b438b..57ae47e86 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,5 +1,4 @@ -""" - Utilities for docstring processing. +"""Utilities for docstring processing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index 90f00ddd5..64726fcee 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -1,5 +1,4 @@ -""" - Utility functions for docutils. +"""Utility functions for docutils. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py index 7e412e2ec..e633f77bd 100644 --- a/sphinx/util/fileutil.py +++ b/sphinx/util/fileutil.py @@ -1,5 +1,4 @@ -""" - File utility functions for Sphinx. +"""File utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py index 0e0621fcd..5e5cbec8a 100644 --- a/sphinx/util/i18n.py +++ b/sphinx/util/i18n.py @@ -1,5 +1,4 @@ -""" - Builder superclass for all builders. +"""Builder superclass for all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/images.py b/sphinx/util/images.py index 508617ca6..05572ec29 100644 --- a/sphinx/util/images.py +++ b/sphinx/util/images.py @@ -1,5 +1,4 @@ -""" - Image utility functions for Sphinx. +"""Image utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 9a66c0ec6..2d6aac13b 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -1,5 +1,4 @@ -""" - Helpers for inspecting Python modules. +"""Helpers for inspecting Python modules. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py index dfc3cd7ba..e8e5e480e 100644 --- a/sphinx/util/inventory.py +++ b/sphinx/util/inventory.py @@ -1,5 +1,4 @@ -""" - Inventory utility functions for Sphinx. +"""Inventory utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index 935a26119..0cad261ce 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -1,5 +1,4 @@ -""" - This module implements a simple JavaScript serializer. +"""This module implements a simple JavaScript serializer. Uses the basestring encode function from simplejson by Bob Ippolito. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py index b78707afe..a0c09bb20 100644 --- a/sphinx/util/logging.py +++ b/sphinx/util/logging.py @@ -1,5 +1,4 @@ -""" - Logging utility functions for Sphinx. +"""Logging utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index e8c000ee1..c84cd757f 100644 --- a/sphinx/util/matching.py +++ b/sphinx/util/matching.py @@ -1,5 +1,4 @@ -""" - Pattern-matching utility functions for Sphinx. +"""Pattern-matching utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/math.py b/sphinx/util/math.py index 0fa945890..0addaa5a0 100644 --- a/sphinx/util/math.py +++ b/sphinx/util/math.py @@ -1,5 +1,4 @@ -""" - Utility functions for math. +"""Utility functions for math. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index 3af9f4dd7..b19597041 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -1,5 +1,4 @@ -""" - Docutils node-related utility functions for Sphinx. +"""Docutils node-related utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index e346170f0..e0d736229 100644 --- a/sphinx/util/osutil.py +++ b/sphinx/util/osutil.py @@ -1,5 +1,4 @@ -""" - Operating system-related utility functions for Sphinx. +"""Operating system-related utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index 3783db7fc..5a63fb9e9 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -1,5 +1,4 @@ -""" - Parallel building utilities. +"""Parallel building utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/png.py b/sphinx/util/png.py index ba9794f62..cb0f86eb9 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -1,5 +1,4 @@ -""" - PNG image manipulation helpers. +"""PNG image manipulation helpers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index 639ccb5ab..a8b105cc7 100644 --- a/sphinx/util/pycompat.py +++ b/sphinx/util/pycompat.py @@ -1,5 +1,4 @@ -""" - Stuff for Python version compatibility. +"""Stuff for Python version compatibility. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py index 78b947ce8..8241bc60b 100644 --- a/sphinx/util/requests.py +++ b/sphinx/util/requests.py @@ -1,5 +1,4 @@ -""" - Simple requests package loader +"""Simple requests package loader :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index 3cb9d64ba..8b0f05507 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -1,5 +1,4 @@ -""" - reST helper functions. +"""reST helper functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/smartypants.py b/sphinx/util/smartypants.py index 512ab839a..363a4c97b 100644 --- a/sphinx/util/smartypants.py +++ b/sphinx/util/smartypants.py @@ -1,5 +1,4 @@ -""" - This is extracted (with minor adaptations for flake8 compliance) from +"""This is extracted (with minor adaptations for flake8 compliance) from docutils’ docutils/utils/smartquotes.py as of revision 8097 (30 May 2017), in order to backport for Sphinx usage with Docutils < 0.14 extra language configurations and fixes. Replaces earlier smartypants version as used up diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py index 0332e3f3b..d7576a94e 100644 --- a/sphinx/util/stemmer/__init__.py +++ b/sphinx/util/stemmer/__init__.py @@ -1,5 +1,4 @@ -""" - Word stemming utilities for Sphinx. +"""Word stemming utilities for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/stemmer/porter.py b/sphinx/util/stemmer/porter.py index e26431646..6068e76ab 100644 --- a/sphinx/util/stemmer/porter.py +++ b/sphinx/util/stemmer/porter.py @@ -1,5 +1,4 @@ -""" - Porter Stemming Algorithm +"""Porter Stemming Algorithm This is the Porter stemming algorithm, ported to Python from the version coded up in ANSI C by the author. It may be be regarded diff --git a/sphinx/util/template.py b/sphinx/util/template.py index c684b8589..2fcd1f245 100644 --- a/sphinx/util/template.py +++ b/sphinx/util/template.py @@ -1,5 +1,4 @@ -""" - Templates utility functions for Sphinx. +"""Templates utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index 92b07521f..c9e421022 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -1,5 +1,4 @@ -""" - TeX escaping helper. +"""TeX escaping helper. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py index df5c9f6e8..0cffd94ff 100644 --- a/sphinx/util/typing.py +++ b/sphinx/util/typing.py @@ -1,5 +1,4 @@ -""" - The composite types for Sphinx. +"""The composite types for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/versioning.py b/sphinx/versioning.py index 09be9aef7..1d7eca5c6 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -1,5 +1,4 @@ -""" - Implements the low-level algorithms Sphinx uses for the versioning of +"""Implements the low-level algorithms Sphinx uses for the versioning of doctrees. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py index 668ecc0f5..711c568df 100644 --- a/sphinx/writers/__init__.py +++ b/sphinx/writers/__init__.py @@ -1,5 +1,4 @@ -""" - Custom docutils writers. +"""Custom docutils writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index e7efff848..08e142650 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -1,5 +1,4 @@ -""" - docutils writers handling Sphinx' custom nodes. +"""docutils writers handling Sphinx' custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index 5324741cd..1e911c8f8 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -1,5 +1,4 @@ -""" - Experimental docutils writers for HTML5 handling Sphinx's custom nodes. +"""Experimental docutils writers for HTML5 handling Sphinx's custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 7956a854d..efabba313 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -1,5 +1,4 @@ -""" - Custom docutils writer for LaTeX. +"""Custom docutils writer for LaTeX. Much of this code is adapted from Dave Kuhlman's "docpy" writer from his docutils sandbox. diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index be7a405b7..1ed8463e8 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -1,5 +1,4 @@ -""" - Manual page writer, extended for Sphinx custom nodes. +"""Manual page writer, extended for Sphinx custom nodes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index 7b7af182d..e307a36a6 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -1,5 +1,4 @@ -""" - Custom docutils writer for Texinfo. +"""Custom docutils writer for Texinfo. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 255beb848..57aa765cd 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -1,5 +1,4 @@ -""" - Custom docutils writer for plain text. +"""Custom docutils writer for plain text. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py index 733b6b3a2..f372db024 100644 --- a/sphinx/writers/xml.py +++ b/sphinx/writers/xml.py @@ -1,5 +1,4 @@ -""" - Docutils-native XML and pseudo-XML writers. +"""Docutils-native XML and pseudo-XML writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/roots/test-inheritance/dummy/test_nested.py b/tests/roots/test-inheritance/dummy/test_nested.py index 1e732aab5..89289fe44 100644 --- a/tests/roots/test-inheritance/dummy/test_nested.py +++ b/tests/roots/test-inheritance/dummy/test_nested.py @@ -1,5 +1,4 @@ -""" - Test with nested classes. +"""Test with nested classes. """ diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py index 303387156..26d85df80 100644 --- a/tests/test_api_translator.py +++ b/tests/test_api_translator.py @@ -1,5 +1,4 @@ -""" - Test the Sphinx API for translator. +"""Test the Sphinx API for translator. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_application.py b/tests/test_application.py index 5eac1f7d0..00b6e7d88 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -1,5 +1,4 @@ -""" - Test the Sphinx class. +"""Test the Sphinx class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build.py b/tests/test_build.py index c5a34280d..87e16dadd 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -1,5 +1,4 @@ -""" - Test all builders. +"""Test all builders. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_changes.py b/tests/test_build_changes.py index 67fe3701d..7b2b1528f 100644 --- a/tests/test_build_changes.py +++ b/tests/test_build_changes.py @@ -1,5 +1,4 @@ -""" - Test the ChangesBuilder class. +"""Test the ChangesBuilder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_dirhtml.py b/tests/test_build_dirhtml.py index cb3958b7d..7cf865adc 100644 --- a/tests/test_build_dirhtml.py +++ b/tests/test_build_dirhtml.py @@ -1,5 +1,4 @@ -""" - Test dirhtml builder. +"""Test dirhtml builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_epub.py b/tests/test_build_epub.py index ce2610b7b..74b4dcea4 100644 --- a/tests/test_build_epub.py +++ b/tests/test_build_epub.py @@ -1,5 +1,4 @@ -""" - Test the HTML builder and check output against XPath. +"""Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index fd227a6a6..c98ecfa1b 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -1,5 +1,4 @@ -""" - Test the build process with gettext builder with the test root. +"""Test the build process with gettext builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 795e93fac..15cba7888 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -1,5 +1,4 @@ -""" - Test the HTML builder and check output against XPath. +"""Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 5a3dc1811..1ccee9571 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -1,5 +1,4 @@ -""" - Test the build process with LaTeX builder with the test root. +"""Test the build process with LaTeX builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py index f5338020b..2efcd6893 100644 --- a/tests/test_build_linkcheck.py +++ b/tests/test_build_linkcheck.py @@ -1,5 +1,4 @@ -""" - Test the build process with manpage builder with the test root. +"""Test the build process with manpage builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_manpage.py b/tests/test_build_manpage.py index 99b61bb0e..5f92d4783 100644 --- a/tests/test_build_manpage.py +++ b/tests/test_build_manpage.py @@ -1,5 +1,4 @@ -""" - Test the build process with manpage builder with the test root. +"""Test the build process with manpage builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py index 3de24cfe4..1f89a4d63 100644 --- a/tests/test_build_texinfo.py +++ b/tests/test_build_texinfo.py @@ -1,5 +1,4 @@ -""" - Test the build process with Texinfo builder with the test root. +"""Test the build process with Texinfo builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_build_text.py b/tests/test_build_text.py index 1b1b507a4..9e4789bc5 100644 --- a/tests/test_build_text.py +++ b/tests/test_build_text.py @@ -1,5 +1,4 @@ -""" - Test the build process with Text builder with the test root. +"""Test the build process with Text builder with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_builder.py b/tests/test_builder.py index cacea6e22..4b6c7d6e1 100644 --- a/tests/test_builder.py +++ b/tests/test_builder.py @@ -1,5 +1,4 @@ -""" - Test the Builder class. +"""Test the Builder class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_catalogs.py b/tests/test_catalogs.py index e2c6b9b21..a4e1327af 100644 --- a/tests/test_catalogs.py +++ b/tests/test_catalogs.py @@ -1,5 +1,4 @@ -""" - Test the base build process. +"""Test the base build process. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_config.py b/tests/test_config.py index f64b912c4..56f223a32 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.config.Config class and its handling in the +"""Test the sphinx.config.Config class and its handling in the Application class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_correct_year.py b/tests/test_correct_year.py index 5c219df1d..9214ed9f4 100644 --- a/tests/test_correct_year.py +++ b/tests/test_correct_year.py @@ -1,5 +1,4 @@ -""" - Test copyright year adjustment +"""Test copyright year adjustment :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_directive_code.py b/tests/test_directive_code.py index e7a9d4505..d1f723945 100644 --- a/tests/test_directive_code.py +++ b/tests/test_directive_code.py @@ -1,5 +1,4 @@ -""" - Test the code-block directive. +"""Test the code-block directive. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_directive_only.py b/tests/test_directive_only.py index 29ea531b8..d29e8d72f 100644 --- a/tests/test_directive_only.py +++ b/tests/test_directive_only.py @@ -1,5 +1,4 @@ -""" - Test the only directive with the test root. +"""Test the only directive with the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_directive_other.py b/tests/test_directive_other.py index 78118c10a..55e745090 100644 --- a/tests/test_directive_other.py +++ b/tests/test_directive_other.py @@ -1,5 +1,4 @@ -""" - Test the other directives. +"""Test the other directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_directive_patch.py b/tests/test_directive_patch.py index 03f86f61b..31aff4a32 100644 --- a/tests/test_directive_patch.py +++ b/tests/test_directive_patch.py @@ -1,5 +1,4 @@ -""" - Test the patched directives. +"""Test the patched directives. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py index 342b3180b..7ecd997c4 100644 --- a/tests/test_docutilsconf.py +++ b/tests/test_docutilsconf.py @@ -1,5 +1,4 @@ -""" - Test docutils.conf support for several writers. +"""Test docutils.conf support for several writers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_c.py b/tests/test_domain_c.py index d386eb81b..84a4f655d 100644 --- a/tests/test_domain_c.py +++ b/tests/test_domain_c.py @@ -1,5 +1,4 @@ -""" - Tests the C Domain +"""Tests the C Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 6239228e1..0d417c14c 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -1,5 +1,4 @@ -""" - Tests the C++ Domain +"""Tests the C++ Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_js.py b/tests/test_domain_js.py index 592360781..4b4be12e6 100644 --- a/tests/test_domain_js.py +++ b/tests/test_domain_js.py @@ -1,5 +1,4 @@ -""" - Tests the JavaScript Domain +"""Tests the JavaScript Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py index 3ffc3f372..643ec2104 100644 --- a/tests/test_domain_py.py +++ b/tests/test_domain_py.py @@ -1,5 +1,4 @@ -""" - Tests the Python Domain +"""Tests the Python Domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_rst.py b/tests/test_domain_rst.py index 231aa6317..43af04f2c 100644 --- a/tests/test_domain_rst.py +++ b/tests/test_domain_rst.py @@ -1,5 +1,4 @@ -""" - Tests the reStructuredText domain. +"""Tests the reStructuredText domain. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py index 5b5f87ff5..4acc723ab 100644 --- a/tests/test_domain_std.py +++ b/tests/test_domain_std.py @@ -1,5 +1,4 @@ -""" - Tests the std domain +"""Tests the std domain :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_environment.py b/tests/test_environment.py index 73ea690fa..0a47716ed 100644 --- a/tests/test_environment.py +++ b/tests/test_environment.py @@ -1,5 +1,4 @@ -""" - Test the BuildEnvironment class. +"""Test the BuildEnvironment class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_environment_indexentries.py b/tests/test_environment_indexentries.py index 505b45e8f..3e68ccc90 100644 --- a/tests/test_environment_indexentries.py +++ b/tests/test_environment_indexentries.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.environment.managers.indexentries. +"""Test the sphinx.environment.managers.indexentries. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py index a2a6a3ed9..369050f86 100644 --- a/tests/test_environment_toctree.py +++ b/tests/test_environment_toctree.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.environment.managers.toctree. +"""Test the sphinx.environment.managers.toctree. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_events.py b/tests/test_events.py index 74649a869..071fa13f4 100644 --- a/tests/test_events.py +++ b/tests/test_events.py @@ -1,5 +1,4 @@ -""" - Test the EventManager class. +"""Test the EventManager class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py index 4e4f8d89e..bbddf5278 100644 --- a/tests/test_ext_apidoc.py +++ b/tests/test_ext_apidoc.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.apidoc module. +"""Test the sphinx.apidoc module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py index 3f48beb7a..f4e2c8ef6 100644 --- a/tests/test_ext_autodoc.py +++ b/tests/test_ext_autodoc.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autoattribute.py b/tests/test_ext_autodoc_autoattribute.py index 1907389d3..e8a49c2d4 100644 --- a/tests/test_ext_autodoc_autoattribute.py +++ b/tests/test_ext_autodoc_autoattribute.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autoclass.py b/tests/test_ext_autodoc_autoclass.py index fd90a7cab..649211c05 100644 --- a/tests/test_ext_autodoc_autoclass.py +++ b/tests/test_ext_autodoc_autoclass.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autodata.py b/tests/test_ext_autodoc_autodata.py index 7462e6182..b2fbaac5d 100644 --- a/tests/test_ext_autodoc_autodata.py +++ b/tests/test_ext_autodoc_autodata.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autofunction.py b/tests/test_ext_autodoc_autofunction.py index 30586e08c..474b3f7f3 100644 --- a/tests/test_ext_autodoc_autofunction.py +++ b/tests/test_ext_autodoc_autofunction.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_automodule.py b/tests/test_ext_autodoc_automodule.py index 8aec1fb48..f99d9a364 100644 --- a/tests/test_ext_autodoc_automodule.py +++ b/tests/test_ext_autodoc_automodule.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_autoproperty.py b/tests/test_ext_autodoc_autoproperty.py index b967d65b8..033e10ead 100644 --- a/tests/test_ext_autodoc_autoproperty.py +++ b/tests/test_ext_autodoc_autoproperty.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly the Documenters; the auto +"""Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_autodoc_configs.py b/tests/test_ext_autodoc_configs.py index ce4f0e064..8f5bb10a1 100644 --- a/tests/test_ext_autodoc_configs.py +++ b/tests/test_ext_autodoc_configs.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly for config variables +"""Test the autodoc extension. This tests mainly for config variables :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_events.py b/tests/test_ext_autodoc_events.py index 0adb0d6a1..02d0c739e 100644 --- a/tests/test_ext_autodoc_events.py +++ b/tests/test_ext_autodoc_events.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly for autodoc events +"""Test the autodoc extension. This tests mainly for autodoc events :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_mock.py b/tests/test_ext_autodoc_mock.py index 1a7a39aa0..c2c520457 100644 --- a/tests/test_ext_autodoc_mock.py +++ b/tests/test_ext_autodoc_mock.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. +"""Test the autodoc extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_preserve_defaults.py b/tests/test_ext_autodoc_preserve_defaults.py index 54c26e226..d00d4e774 100644 --- a/tests/test_ext_autodoc_preserve_defaults.py +++ b/tests/test_ext_autodoc_preserve_defaults.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. +"""Test the autodoc extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autodoc_private_members.py b/tests/test_ext_autodoc_private_members.py index dbb8f759b..761c48c52 100644 --- a/tests/test_ext_autodoc_private_members.py +++ b/tests/test_ext_autodoc_private_members.py @@ -1,5 +1,4 @@ -""" - Test the autodoc extension. This tests mainly for private-members option. +"""Test the autodoc extension. This tests mainly for private-members option. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autosectionlabel.py b/tests/test_ext_autosectionlabel.py index 307439e99..0a8732a12 100644 --- a/tests/test_ext_autosectionlabel.py +++ b/tests/test_ext_autosectionlabel.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.autosectionlabel extension. +"""Test sphinx.ext.autosectionlabel extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py index 3bc4d3bd9..0a9a965e0 100644 --- a/tests/test_ext_autosummary.py +++ b/tests/test_ext_autosummary.py @@ -1,5 +1,4 @@ -""" - Test the autosummary extension. +"""Test the autosummary extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_coverage.py b/tests/test_ext_coverage.py index 4c2e799bd..ad96cafbd 100644 --- a/tests/test_ext_coverage.py +++ b/tests/test_ext_coverage.py @@ -1,5 +1,4 @@ -""" - Test the coverage builder. +"""Test the coverage builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index dbda96c15..c1c02fd0e 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -1,5 +1,4 @@ -""" - Test the doctest extension. +"""Test the doctest extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_duration.py b/tests/test_ext_duration.py index c1f2ca96e..71b7a8f9c 100644 --- a/tests/test_ext_duration.py +++ b/tests/test_ext_duration.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.duration extension. +"""Test sphinx.ext.duration extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_githubpages.py b/tests/test_ext_githubpages.py index 3b63a2c2e..d3d703fb1 100644 --- a/tests/test_ext_githubpages.py +++ b/tests/test_ext_githubpages.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.githubpages extension. +"""Test sphinx.ext.githubpages extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py index f916fb1b9..f6812a9ce 100644 --- a/tests/test_ext_graphviz.py +++ b/tests/test_ext_graphviz.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.graphviz extension. +"""Test sphinx.ext.graphviz extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_ifconfig.py b/tests/test_ext_ifconfig.py index 4bc7f519f..e225ff76a 100644 --- a/tests/test_ext_ifconfig.py +++ b/tests/test_ext_ifconfig.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.ifconfig extension. +"""Test sphinx.ext.ifconfig extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_imgconverter.py b/tests/test_ext_imgconverter.py index 478bf8df4..5e5f00b15 100644 --- a/tests/test_ext_imgconverter.py +++ b/tests/test_ext_imgconverter.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.imgconverter extension. +"""Test sphinx.ext.imgconverter extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py index ad594c2eb..2d1b61e62 100644 --- a/tests/test_ext_inheritance_diagram.py +++ b/tests/test_ext_inheritance_diagram.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.inheritance_diagram extension. +"""Test sphinx.ext.inheritance_diagram extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py index 21ce6f952..f363c6c96 100644 --- a/tests/test_ext_intersphinx.py +++ b/tests/test_ext_intersphinx.py @@ -1,5 +1,4 @@ -""" - Test the intersphinx extension. +"""Test the intersphinx extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index 20fc75279..18ad0968e 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -1,5 +1,4 @@ -""" - Test math extensions. +"""Test math extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_napoleon.py b/tests/test_ext_napoleon.py index 75894f9c0..8ce4b542d 100644 --- a/tests/test_ext_napoleon.py +++ b/tests/test_ext_napoleon.py @@ -1,5 +1,4 @@ -""" - Tests for :mod:`sphinx.ext.napoleon.__init__` module. +"""Tests for :mod:`sphinx.ext.napoleon.__init__` module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index eb2252fb9..271e08333 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -1,5 +1,4 @@ -""" - Tests for :mod:`sphinx.ext.napoleon.docstring` module. +"""Tests for :mod:`sphinx.ext.napoleon.docstring` module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_napoleon_iterators.py b/tests/test_ext_napoleon_iterators.py index 0ccc94a06..74618f740 100644 --- a/tests/test_ext_napoleon_iterators.py +++ b/tests/test_ext_napoleon_iterators.py @@ -1,5 +1,4 @@ -""" - Tests for :mod:`sphinx.ext.napoleon.iterators` module. +"""Tests for :mod:`sphinx.ext.napoleon.iterators` module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_ext_todo.py b/tests/test_ext_todo.py index 010b66034..93c0cb7ca 100644 --- a/tests/test_ext_todo.py +++ b/tests/test_ext_todo.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.todo extension. +"""Test sphinx.ext.todo extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py index 5b416d14d..688fa7607 100644 --- a/tests/test_ext_viewcode.py +++ b/tests/test_ext_viewcode.py @@ -1,5 +1,4 @@ -""" - Test sphinx.ext.viewcode extension. +"""Test sphinx.ext.viewcode extension. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_extension.py b/tests/test_extension.py index 0955dc382..ca35e0ae5 100644 --- a/tests/test_extension.py +++ b/tests/test_extension.py @@ -1,5 +1,4 @@ -""" - Test sphinx.extension module. +"""Test sphinx.extension module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index 4238882df..0b0687196 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -1,5 +1,4 @@ -""" - Test the Pygments highlighting bridge. +"""Test the Pygments highlighting bridge. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_intl.py b/tests/test_intl.py index c89df5732..8fccb33b6 100644 --- a/tests/test_intl.py +++ b/tests/test_intl.py @@ -1,5 +1,4 @@ -""" - Test message patching for internationalization purposes. Runs the text +"""Test message patching for internationalization purposes. Runs the text builder in the test root. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/tests/test_locale.py b/tests/test_locale.py index aadac7b8f..f88e17b78 100644 --- a/tests/test_locale.py +++ b/tests/test_locale.py @@ -1,5 +1,4 @@ -""" - Test locale. +"""Test locale. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_markup.py b/tests/test_markup.py index a2ffbf17e..c7c955048 100644 --- a/tests/test_markup.py +++ b/tests/test_markup.py @@ -1,5 +1,4 @@ -""" - Test various Sphinx-specific markup extensions. +"""Test various Sphinx-specific markup extensions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_metadata.py b/tests/test_metadata.py index 86a9896bf..0092158aa 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1,5 +1,4 @@ -""" - Test our handling of metadata in files with bibliographic metadata. +"""Test our handling of metadata in files with bibliographic metadata. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_parser.py b/tests/test_parser.py index 8098c74af..3ff10eff8 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -1,5 +1,4 @@ -""" - Tests parsers module. +"""Tests parsers module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_project.py b/tests/test_project.py index 6996e8202..cd48c33a1 100644 --- a/tests/test_project.py +++ b/tests/test_project.py @@ -1,5 +1,4 @@ -""" - Tests project module. +"""Tests project module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_pycode.py b/tests/test_pycode.py index 267395a21..1de3f615d 100644 --- a/tests/test_pycode.py +++ b/tests/test_pycode.py @@ -1,5 +1,4 @@ -""" - Test pycode. +"""Test pycode. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_pycode_ast.py b/tests/test_pycode_ast.py index d1150e3b0..6cf8b77ee 100644 --- a/tests/test_pycode_ast.py +++ b/tests/test_pycode_ast.py @@ -1,5 +1,4 @@ -""" - Test pycode.ast +"""Test pycode.ast :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_pycode_parser.py b/tests/test_pycode_parser.py index 264636907..c1456a0a6 100644 --- a/tests/test_pycode_parser.py +++ b/tests/test_pycode_parser.py @@ -1,5 +1,4 @@ -""" - Test pycode.parser. +"""Test pycode.parser. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py index 940897b5b..c4eaed0ae 100644 --- a/tests/test_quickstart.py +++ b/tests/test_quickstart.py @@ -1,5 +1,4 @@ -""" - Test the sphinx.quickstart module. +"""Test the sphinx.quickstart module. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_roles.py b/tests/test_roles.py index b531c7d8b..5cf78f18d 100644 --- a/tests/test_roles.py +++ b/tests/test_roles.py @@ -1,5 +1,4 @@ -""" - Test sphinx.roles +"""Test sphinx.roles :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_search.py b/tests/test_search.py index e2cac35c1..f58164141 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -1,5 +1,4 @@ -""" - Test the search index builder. +"""Test the search index builder. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py index 41571a2c1..d1bbb5823 100644 --- a/tests/test_setup_command.py +++ b/tests/test_setup_command.py @@ -1,5 +1,4 @@ -""" - Test setup_command for distutils. +"""Test setup_command for distutils. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_smartquotes.py b/tests/test_smartquotes.py index 78f0faae8..c7920f26a 100644 --- a/tests/test_smartquotes.py +++ b/tests/test_smartquotes.py @@ -1,5 +1,4 @@ -""" - Test smart quotes. +"""Test smart quotes. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_templating.py b/tests/test_templating.py index 1def07050..f519b5e8d 100644 --- a/tests/test_templating.py +++ b/tests/test_templating.py @@ -1,5 +1,4 @@ -""" - Test templating. +"""Test templating. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_theming.py b/tests/test_theming.py index b760671bc..4178114c9 100644 --- a/tests/test_theming.py +++ b/tests/test_theming.py @@ -1,5 +1,4 @@ -""" - Test the Theme class. +"""Test the Theme class. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_toctree.py b/tests/test_toctree.py index 62f561d87..8e422041b 100644 --- a/tests/test_toctree.py +++ b/tests/test_toctree.py @@ -1,5 +1,4 @@ -""" - Test the HTML builder and check output against XPath. +"""Test the HTML builder and check output against XPath. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_transforms_post_transforms.py b/tests/test_transforms_post_transforms.py index c3e7613fe..e7dba7619 100644 --- a/tests/test_transforms_post_transforms.py +++ b/tests/test_transforms_post_transforms.py @@ -1,5 +1,4 @@ -""" - Tests the post_transforms +"""Tests the post_transforms :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util.py b/tests/test_util.py index ade5d36f9..76ae43bcd 100644 --- a/tests/test_util.py +++ b/tests/test_util.py @@ -1,5 +1,4 @@ -""" - Tests util functions. +"""Tests util functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_docstrings.py b/tests/test_util_docstrings.py index fe8727e66..a8ac6912e 100644 --- a/tests/test_util_docstrings.py +++ b/tests/test_util_docstrings.py @@ -1,5 +1,4 @@ -""" - Test sphinx.util.docstrings. +"""Test sphinx.util.docstrings. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_docutils.py b/tests/test_util_docutils.py index 2ee8953a7..3af3861f9 100644 --- a/tests/test_util_docutils.py +++ b/tests/test_util_docutils.py @@ -1,5 +1,4 @@ -""" - Tests util.utils functions. +"""Tests util.utils functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_fileutil.py b/tests/test_util_fileutil.py index 90264a945..d1d4297c0 100644 --- a/tests/test_util_fileutil.py +++ b/tests/test_util_fileutil.py @@ -1,5 +1,4 @@ -""" - Tests sphinx.util.fileutil functions. +"""Tests sphinx.util.fileutil functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_i18n.py b/tests/test_util_i18n.py index fd67446ae..49118daae 100644 --- a/tests/test_util_i18n.py +++ b/tests/test_util_i18n.py @@ -1,5 +1,4 @@ -""" - Test i18n util. +"""Test i18n util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_images.py b/tests/test_util_images.py index 5dbe2a8ed..7b21af430 100644 --- a/tests/test_util_images.py +++ b/tests/test_util_images.py @@ -1,5 +1,4 @@ -""" - Test images util. +"""Test images util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 18abbe86c..02e7244cd 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -1,5 +1,4 @@ -""" - Tests util.inspect functions. +"""Tests util.inspect functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_inventory.py b/tests/test_util_inventory.py index d621fd17d..1aae84589 100644 --- a/tests/test_util_inventory.py +++ b/tests/test_util_inventory.py @@ -1,5 +1,4 @@ -""" - Test inventory util functions. +"""Test inventory util functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py index bb3d3260a..42bfd137b 100644 --- a/tests/test_util_logging.py +++ b/tests/test_util_logging.py @@ -1,5 +1,4 @@ -""" - Test logging util. +"""Test logging util. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_matching.py b/tests/test_util_matching.py index 91d284b23..4a7fd28dc 100644 --- a/tests/test_util_matching.py +++ b/tests/test_util_matching.py @@ -1,5 +1,4 @@ -""" - Tests sphinx.util.matching functions. +"""Tests sphinx.util.matching functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_nodes.py b/tests/test_util_nodes.py index a682dc295..71e2d637a 100644 --- a/tests/test_util_nodes.py +++ b/tests/test_util_nodes.py @@ -1,5 +1,4 @@ -""" - Tests uti.nodes functions. +"""Tests uti.nodes functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_rst.py b/tests/test_util_rst.py index 4f76f584a..f80f7cdef 100644 --- a/tests/test_util_rst.py +++ b/tests/test_util_rst.py @@ -1,5 +1,4 @@ -""" - Tests sphinx.util.rst functions. +"""Tests sphinx.util.rst functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_template.py b/tests/test_util_template.py index b752a4c34..5380716aa 100644 --- a/tests/test_util_template.py +++ b/tests/test_util_template.py @@ -1,5 +1,4 @@ -""" - Tests sphinx.util.template functions. +"""Tests sphinx.util.template functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_util_typing.py b/tests/test_util_typing.py index ca3611a44..470524e23 100644 --- a/tests/test_util_typing.py +++ b/tests/test_util_typing.py @@ -1,5 +1,4 @@ -""" - Tests util.typing functions. +"""Tests util.typing functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_versioning.py b/tests/test_versioning.py index f615eb2cc..af00d56b1 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -1,5 +1,4 @@ -""" - Test the versioning implementation. +"""Test the versioning implementation. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/tests/test_writer_latex.py b/tests/test_writer_latex.py index 31d27d591..0ab8511da 100644 --- a/tests/test_writer_latex.py +++ b/tests/test_writer_latex.py @@ -1,5 +1,4 @@ -""" - Test the LaTeX writer +"""Test the LaTeX writer :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/utils/checks.py b/utils/checks.py index 6798fde01..f69242614 100644 --- a/utils/checks.py +++ b/utils/checks.py @@ -1,5 +1,4 @@ -""" - Custom, Sphinx-only flake8 plugins. +"""Custom, Sphinx-only flake8 plugins. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/utils/doclinter.py b/utils/doclinter.py index ed61b9c97..93351becb 100644 --- a/utils/doclinter.py +++ b/utils/doclinter.py @@ -1,5 +1,4 @@ -""" - A linter for Sphinx docs +"""A linter for Sphinx docs :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/utils/jssplitter_generator.py b/utils/jssplitter_generator.py index 0e95cfe56..c62ceb37f 100644 --- a/utils/jssplitter_generator.py +++ b/utils/jssplitter_generator.py @@ -112,8 +112,7 @@ console.log(' ... ok\\n') ''' % js_src python_src = '''\ -""" - Provides Python compatible word splitter to JavaScript +"""Provides Python compatible word splitter to JavaScript DO NOT EDIT. This is generated by utils/jssplitter_generator.py |