Merge pull request #10212 from AA-Turner/remove-module-docstring-titles

Remove module docstring titles

LICENSE

@@ -1,6 +1,9 @@
 License for Sphinx
 ==================
 
+Unless otherwise indicated, all code in the Sphinx project is licenced under the
+two clause BSD licence below.
+
 Copyright (c) 2007-2022 by the Sphinx team (see AUTHORS file).
 All rights reserved.
 

setup.cfg

@@ -35,12 +35,6 @@ import-order-style = smarkets
 per-file-ignores =
     tests/*: E501
 
-[flake8:local-plugins]
-extension =
-    X101 = utils.checks:sphinx_has_header
-paths =
-    .
-
 [isort]
 line_length = 95
 

sphinx/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""The Sphinx documentation toolchain."""
-    Sphinx
-    ~~~~~~
-
-    The Sphinx documentation toolchain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 # Keep this file executable as-is in Python 3!
 # (Otherwise getting the version out of it from setup.py is impossible.)

sphinx/__main__.py

@@ -1,12 +1,4 @@
-"""
+"""The Sphinx documentation toolchain."""
-    sphinx.__main__
-    ~~~~~~~~~~~~~~~
-
-    The Sphinx documentation toolchain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import sys
 

sphinx/addnodes.py

@@ -1,12 +1,4 @@
-"""
+"""Additional docutils nodes."""
-    sphinx.addnodes
-    ~~~~~~~~~~~~~~~
-
-    Additional docutils nodes.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import TYPE_CHECKING, Any, Dict, List, Sequence
 

sphinx/application.py

@@ -1,13 +1,6 @@
-"""
+"""Sphinx application class and extensibility interface.
-    sphinx.application
-    ~~~~~~~~~~~~~~~~~~
 
-    Sphinx application class and extensibility interface.
+Gracefully adapted from the TextPress system by Armin.
-
-    Gracefully adapted from the TextPress system by Armin.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import os

sphinx/builders/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""Builder superclass for all builders."""
-    sphinx.builders
-    ~~~~~~~~~~~~~~~
-
-    Builder superclass for all builders.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import pickle
 import time

sphinx/builders/_epub_base.py

@@ -1,12 +1,4 @@
-"""
+"""Base class of epub2/epub3 builders."""
-    sphinx.builders._epub_base
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Base class of epub2/epub3 builders.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import html
 import os

sphinx/builders/changes.py

@@ -1,12 +1,4 @@
-"""
+"""Changelog builder."""
-    sphinx.builders.changes
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    Changelog builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import html
 from os import path

sphinx/builders/dirhtml.py

@@ -1,12 +1,4 @@
-"""
+"""Directory HTML builders."""
-    sphinx.builders.dirhtml
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    Directory HTML builders.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from os import path
 from typing import Any, Dict

sphinx/builders/dummy.py

@@ -1,12 +1,4 @@
-"""
+"""Do syntax checks, but no writing."""
-    sphinx.builders.dummy
-    ~~~~~~~~~~~~~~~~~~~~~
-
-    Do syntax checks, but no writing.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, Set
 

sphinx/builders/epub3.py

@@ -1,12 +1,6 @@
-"""
+"""Build epub3 files.
-    sphinx.builders.epub3
-    ~~~~~~~~~~~~~~~~~~~~~
 
-    Build epub3 files.
+Originally derived from epub.py.
-    Originally derived from epub.py.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import html

sphinx/builders/gettext.py

@@ -1,12 +1,4 @@
-"""
+"""The MessageCatalogBuilder class."""
-    sphinx.builders.gettext
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    The MessageCatalogBuilder class.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from codecs import open
 from collections import OrderedDict, defaultdict

sphinx/builders/html/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""Several HTML builders."""
-    sphinx.builders.html
-    ~~~~~~~~~~~~~~~~~~~~
-
-    Several HTML builders.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import html
 import os

sphinx/builders/html/transforms.py

@@ -1,12 +1,4 @@
-"""
+"""Transforms for HTML builder."""
-    sphinx.builders.html.transforms
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Transforms for HTML builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 from typing import Any, Dict, List

sphinx/builders/latex/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""LaTeX builder."""
-    sphinx.builders.latex
-    ~~~~~~~~~~~~~~~~~~~~~
-
-    LaTeX builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import os
 import warnings

sphinx/builders/latex/constants.py

@@ -1,12 +1,4 @@
-"""
+"""consntants for LaTeX builder."""
-    sphinx.builders.latex.constants
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    consntants for LaTeX builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict
 

sphinx/builders/latex/nodes.py

@@ -1,12 +1,4 @@
-"""
+"""Additional nodes for LaTeX writer."""
-    sphinx.builders.latex.nodes
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Additional nodes for LaTeX writer.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from docutils import nodes
 

sphinx/builders/latex/theming.py

@@ -1,12 +1,4 @@
-"""
+"""Theming support for LaTeX builder."""
-    sphinx.builders.latex.theming
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Theming support for LaTeX builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import configparser
 from os import path

sphinx/builders/latex/transforms.py

@@ -1,12 +1,4 @@
-"""
+"""Transforms for LaTeX builder."""
-    sphinx.builders.latex.transforms
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Transforms for LaTeX builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, List, Set, Tuple, cast
 

sphinx/builders/latex/util.py

@@ -1,12 +1,4 @@
-"""
+"""Utilities for LaTeX builder."""
-    sphinx.builders.latex.util
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Utilities for LaTeX builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Optional
 

sphinx/builders/linkcheck.py

@@ -1,12 +1,4 @@
-"""
+"""The CheckExternalLinksBuilder class."""
-    sphinx.builders.linkcheck
-    ~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The CheckExternalLinksBuilder class.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import json
 import re

sphinx/builders/manpage.py

@@ -1,12 +1,4 @@
-"""
+"""Manual pages builder."""
-    sphinx.builders.manpage
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    Manual pages builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from os import path
 from typing import Any, Dict, List, Set, Tuple, Union

sphinx/builders/singlehtml.py

@@ -1,12 +1,4 @@
-"""
+"""Single HTML builders."""
-    sphinx.builders.singlehtml
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Single HTML builders.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from os import path
 from typing import Any, Dict, List, Tuple, Union

sphinx/builders/texinfo.py

@@ -1,12 +1,4 @@
-"""
+"""Texinfo builder."""
-    sphinx.builders.texinfo
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    Texinfo builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import os
 from os import path

sphinx/builders/text.py

@@ -1,12 +1,4 @@
-"""
+"""Plain-text Sphinx builder."""
-    sphinx.builders.text
-    ~~~~~~~~~~~~~~~~~~~~
-
-    Plain-text Sphinx builder.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from os import path
 from typing import Any, Dict, Iterator, Set, Tuple

sphinx/builders/xml.py

@@ -1,12 +1,4 @@
-"""
+"""Docutils-native XML and pseudo-XML builders."""
-    sphinx.builders.xml
-    ~~~~~~~~~~~~~~~~~~~
-
-    Docutils-native XML and pseudo-XML builders.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from os import path
 from typing import Any, Dict, Iterator, Set, Type, Union

sphinx/cmd/__init__.py

@@ -1,9 +1 @@
-"""
+"""Modules for command line executables."""
-    sphinx.cmd
-    ~~~~~~~~~~
-
-    Modules for command line executables.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""

sphinx/cmd/build.py

@@ -1,12 +1,4 @@
-"""
+"""Build documentation from a provided source."""
-    sphinx.cmd.build
-    ~~~~~~~~~~~~~~~~
-
-    Build documentation from a provided source.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import argparse
 import bdb

sphinx/cmd/make_mode.py

@@ -1,17 +1,10 @@
-"""
+"""sphinx-build -M command-line handling.
-    sphinx.cmd.make_mode
-    ~~~~~~~~~~~~~~~~~~~~
 
-    sphinx-build -M command-line handling.
+This replaces the old, platform-dependent and once-generated content
+of Makefile / make.bat.
 
-    This replaces the old, platform-dependent and once-generated content
+This is in its own module so that importing it is fast.  It should not
-    of Makefile / make.bat.
+import the main Sphinx modules (like sphinx.applications, sphinx.builders).
-
-    This is in its own module so that importing it is fast.  It should not
-    import the main Sphinx modules (like sphinx.applications, sphinx.builders).
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import os

sphinx/cmd/quickstart.py

@@ -1,12 +1,4 @@
-"""
+"""Quickly setup documentation source to work with Sphinx."""
-    sphinx.cmd.quickstart
-    ~~~~~~~~~~~~~~~~~~~~~
-
-    Quickly setup documentation source to work with Sphinx.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import argparse
 import locale

sphinx/config.py

@@ -1,12 +1,4 @@
-"""
+"""Build configuration file handling."""
-    sphinx.config
-    ~~~~~~~~~~~~~
-
-    Build configuration file handling.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 import traceback

sphinx/deprecation.py

@@ -1,12 +1,4 @@
-"""
+"""Sphinx deprecation classes and utilities."""
-    sphinx.deprecation
-    ~~~~~~~~~~~~~~~~~~
-
-    Sphinx deprecation classes and utilities.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import sys
 import warnings

sphinx/directives/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""Handlers for additional ReST directives."""
-    sphinx.directives
-    ~~~~~~~~~~~~~~~~~
-
-    Handlers for additional ReST directives.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 from typing import TYPE_CHECKING, Any, Dict, Generic, List, Tuple, TypeVar, cast

sphinx/directives/code.py

@@ -1,11 +1,3 @@
-"""
-    sphinx.directives.code
-    ~~~~~~~~~~~~~~~~~~~~~~
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
-
 import sys
 import textwrap
 from difflib import unified_diff

sphinx/directives/other.py

@@ -1,11 +1,3 @@
-"""
-    sphinx.directives.other
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
-
 import re
 from typing import TYPE_CHECKING, Any, Dict, List, cast
 

sphinx/directives/patches.py

@@ -1,11 +1,3 @@
-"""
-    sphinx.directives.patches
-    ~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
-
 import os
 import warnings
 from os import path

sphinx/domains/__init__.py

@@ -1,12 +1,7 @@
-"""
+"""Support for domains.
-    sphinx.domains
-    ~~~~~~~~~~~~~~
 
-    Support for domains, which are groupings of description directives
+Domains are groupings of description directives
-    and roles describing e.g. constructs of one programming language.
+and roles describing e.g. constructs of one programming language.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import copy

sphinx/domains/c.py

@@ -1,12 +1,4 @@
-"""
+"""The C language domain."""
-    sphinx.domains.c
-    ~~~~~~~~~~~~~~~~
-
-    The C language domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 from typing import (Any, Callable, Dict, Generator, Iterator, List, Optional, Tuple, TypeVar,

sphinx/domains/changeset.py

@@ -1,12 +1,4 @@
-"""
+"""The changeset domain."""
-    sphinx.domains.changeset
-    ~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The changeset domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, cast
 

sphinx/domains/citation.py

@@ -1,12 +1,4 @@
-"""
+"""The citation domain."""
-    sphinx.domains.citation
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    The citation domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, cast
 

sphinx/domains/cpp.py

@@ -1,12 +1,4 @@
-"""
+"""The C++ language domain."""
-    sphinx.domains.cpp
-    ~~~~~~~~~~~~~~~~~~
-
-    The C++ language domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 from typing import (Any, Callable, Dict, Generator, Iterator, List, Optional, Tuple, TypeVar,

sphinx/domains/index.py

@@ -1,12 +1,4 @@
-"""
+"""The index domain."""
-    sphinx.domains.index
-    ~~~~~~~~~~~~~~~~~~~~
-
-    The index domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Tuple
 

sphinx/domains/javascript.py

@@ -1,12 +1,4 @@
-"""
+"""The JavaScript domain."""
-    sphinx.domains.javascript
-    ~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The JavaScript domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, Iterator, List, Optional, Tuple, cast
 

sphinx/domains/math.py

@@ -1,12 +1,4 @@
-"""
+"""The math domain."""
-    sphinx.domains.math
-    ~~~~~~~~~~~~~~~~~~~
-
-    The math domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple
 

sphinx/domains/python.py

@@ -1,12 +1,4 @@
-"""
+"""The Python domain."""
-    sphinx.domains.python
-    ~~~~~~~~~~~~~~~~~~~~~
-
-    The Python domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import builtins
 import inspect

sphinx/domains/rst.py

@@ -1,12 +1,4 @@
-"""
+"""The reStructuredText domain."""
-    sphinx.domains.rst
-    ~~~~~~~~~~~~~~~~~~
-
-    The reStructuredText domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 from typing import Any, Dict, Iterator, List, Optional, Tuple, cast

sphinx/domains/std.py

@@ -1,12 +1,4 @@
-"""
+"""The standard domain."""
-    sphinx.domains.std
-    ~~~~~~~~~~~~~~~~~~
-
-    The standard domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 import warnings

sphinx/environment/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""Global creation environment."""
-    sphinx.environment
-    ~~~~~~~~~~~~~~~~~~
-
-    Global creation environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import os
 import pickle

sphinx/environment/adapters/__init__.py

@@ -1,9 +1 @@
-"""
+"""Sphinx environment adapters"""
-    sphinx.environment.adapters
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Sphinx environment adapters
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""

sphinx/environment/adapters/asset.py

@@ -1,12 +1,4 @@
-"""
+"""Assets adapter for sphinx.environment."""
-    sphinx.environment.adapters.asset
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Assets adapter for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from sphinx.environment import BuildEnvironment
 

sphinx/environment/adapters/indexentries.py

@@ -1,12 +1,4 @@
-"""
+"""Index entries adapters for sphinx.environment."""
-    sphinx.environment.adapters.indexentries
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Index entries adapters for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 import unicodedata

sphinx/environment/adapters/toctree.py

@@ -1,12 +1,4 @@
-"""
+"""Toctree adapter for sphinx.environment."""
-    sphinx.environment.adapters.toctree
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Toctree adapter for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import TYPE_CHECKING, Any, Iterable, List, Optional, cast
 

sphinx/environment/collectors/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""The data collector components for sphinx.environment."""
-    sphinx.environment.collectors
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The data collector components for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import TYPE_CHECKING, Dict, List, Optional, Set
 

sphinx/environment/collectors/asset.py

@@ -1,12 +1,4 @@
-"""
+"""The image collector for sphinx.environment."""
-    sphinx.environment.collectors.asset
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The image collector for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import os
 from glob import glob

sphinx/environment/collectors/dependencies.py

@@ -1,12 +1,4 @@
-"""
+"""The dependencies collector components for sphinx.environment."""
-    sphinx.environment.collectors.dependencies
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The dependencies collector components for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import os
 from os import path

sphinx/environment/collectors/metadata.py

@@ -1,12 +1,4 @@
-"""
+"""The metadata collector components for sphinx.environment."""
-    sphinx.environment.collectors.metadata
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The metadata collector components for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, List, Set, cast
 

sphinx/environment/collectors/title.py

@@ -1,12 +1,4 @@
-"""
+"""The title collector components for sphinx.environment."""
-    sphinx.environment.collectors.title
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The title collector components for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, Set
 

sphinx/environment/collectors/toctree.py

@@ -1,12 +1,4 @@
-"""
+"""Toctree collector for sphinx.environment."""
-    sphinx.environment.collectors.toctree
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Toctree collector for sphinx.environment.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, List, Set, Tuple, Type, TypeVar, cast
 

sphinx/errors.py

@@ -1,13 +1,4 @@
-"""
+"""Contains SphinxError and a few subclasses."""
-    sphinx.errors
-    ~~~~~~~~~~~~~
-
-    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.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any
 

sphinx/events.py

@@ -1,13 +1,6 @@
-"""
+"""Sphinx core events.
-    sphinx.events
-    ~~~~~~~~~~~~~
 
-    Sphinx core events.
+Gracefully adapted from the TextPress system by Armin.
-
-    Gracefully adapted from the TextPress system by Armin.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 from collections import defaultdict

sphinx/ext/__init__.py

@@ -1,9 +1 @@
-"""
+"""Contains Sphinx features not activated by default."""
-    sphinx.ext
-    ~~~~~~~~~~
-
-    Contains Sphinx features not activated by default.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""

sphinx/ext/apidoc.py

@@ -1,17 +1,12 @@
-"""
+"""Creates reST files corresponding to Python modules for code documentation.
-    sphinx.ext.apidoc
-    ~~~~~~~~~~~~~~~~~
 
-    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
+ReST files appropriately to create code documentation with Sphinx.  It also
-    creates a modules index (named modules.<suffix>).
+creates a modules index (named modules.<suffix>).
 
-    This is derived from the "sphinx-autopackage" script, which is:
+This is derived from the "sphinx-autopackage" script, which is:
-    Copyright 2008 Société des arts technologiques (SAT),
+Copyright 2008 Société des arts technologiques (SAT),
-    https://sat.qc.ca/
+https://sat.qc.ca/
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import argparse

sphinx/ext/autodoc/__init__.py

@@ -1,13 +1,8 @@
-"""
+"""Extension to create automatic documentation from code docstrings.
-    sphinx.ext.autodoc
-    ~~~~~~~~~~~~~~~~~~
 
-    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
+the doctree, thus avoiding duplication between docstrings and documentation
-    for those who like elaborate docstrings.
+for those who like elaborate docstrings.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import re

sphinx/ext/autodoc/deprecated.py

@@ -1,12 +1,4 @@
-"""
+"""The deprecated Documenters for autodoc."""
-    sphinx.ext.autodoc.deprecated
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The deprecated Documenters for autodoc.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import warnings
 from typing import Any

sphinx/ext/autodoc/directive.py

@@ -1,11 +1,3 @@
-"""
-    sphinx.ext.autodoc.directive
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
-
 import warnings
 from typing import Any, Callable, Dict, List, Set, Type
 

sphinx/ext/autodoc/importer.py

@@ -1,12 +1,4 @@
-"""
+"""Importer utilities for autodoc"""
-    sphinx.ext.autodoc.importer
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Importer utilities for autodoc
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import importlib
 import traceback

sphinx/ext/autodoc/mock.py

@@ -1,12 +1,4 @@
-"""
+"""mock for autodoc"""
-    sphinx.ext.autodoc.mock
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    mock for autodoc
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import contextlib
 import os

sphinx/ext/autodoc/preserve_defaults.py

@@ -1,12 +1,7 @@
-"""
+"""Preserve function defaults.
-    sphinx.ext.autodoc.preserve_defaults
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    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.
+and keep them not evaluated for readability.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import ast

sphinx/ext/autodoc/type_comment.py

@@ -1,12 +1,4 @@
-"""
+"""Update annotations info of living objects using type_comments."""
-    sphinx.ext.autodoc.type_comment
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Update annotations info of living objects using type_comments.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from inspect import Parameter, Signature, getsource
 from typing import Any, Dict, List, cast

sphinx/ext/autodoc/typehints.py

@@ -1,12 +1,4 @@
-"""
+"""Generating content for autodoc using typehints"""
-    sphinx.ext.autodoc.typehints
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Generating content for autodoc using typehints
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 from collections import OrderedDict

sphinx/ext/autosectionlabel.py

@@ -1,12 +1,4 @@
-"""
+"""Allow reference sections by :ref: role using its title."""
-    sphinx.ext.autosectionlabel
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Allow reference sections by :ref: role using its title.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, cast
 

sphinx/ext/autosummary/__init__.py

@@ -1,55 +1,49 @@
-"""
+"""Extension that adds an autosummary:: directive.
-    sphinx.ext.autosummary
-    ~~~~~~~~~~~~~~~~~~~~~~
 
-    Sphinx extension that adds an autosummary:: directive, which can be
+The directive can be used to generate function/method/attribute/etc. summary
-    used to generate function/method/attribute/etc. summary lists, similar
+lists, similar to those output eg. by Epydoc and other API doc generation tools.
-    to those output eg. by Epydoc and other API doc generation tools.
 
-    An :autolink: role is also provided.
+An :autolink: role is also provided.
 
-    autosummary directive
+autosummary directive
-    ---------------------
+---------------------
 
-    The autosummary directive has the form::
+The autosummary directive has the form::
 
-        .. autosummary::
+    .. autosummary::
-           :nosignatures:
+       :nosignatures:
-           :toctree: generated/
+       :toctree: generated/
 
-           module.function_1
+       module.function_1
-           module.function_2
+       module.function_2
-           ...
+       ...
 
-    and it generates an output table (containing signatures, optionally)
+and it generates an output table (containing signatures, optionally)
 
-        ========================  =============================================
+    ========================  =============================================
-        module.function_1(args)   Summary line from the docstring of function_1
+    module.function_1(args)   Summary line from the docstring of function_1
-        module.function_2(args)   Summary line from the docstring
+    module.function_2(args)   Summary line from the docstring
-        ...
+    ...
-        ========================  =============================================
+    ========================  =============================================
 
-    If the :toctree: option is specified, files matching the function names
+If the :toctree: option is specified, files matching the function names
-    are inserted to the toctree with the given prefix:
+are inserted to the toctree with the given prefix:
 
-        generated/module.function_1
+    generated/module.function_1
-        generated/module.function_2
+    generated/module.function_2
-        ...
+    ...
 
-    Note: The file names contain the module:: or currentmodule:: prefixes.
+Note: The file names contain the module:: or currentmodule:: prefixes.
 
-    .. seealso:: autosummary_generate.py
+.. seealso:: autosummary_generate.py
 
 
-    autolink role
+autolink role
-    -------------
+-------------
 
-    The autolink role functions as ``:obj:`` when the name referred can be
+The autolink role functions as ``:obj:`` when the name referred can be
-    resolved to a Python object, and otherwise it becomes simple emphasis.
+resolved to a Python object, and otherwise it becomes simple emphasis.
-    This can be used as the default role to make links 'smart'.
+This can be used as the default role to make links 'smart'.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import inspect

sphinx/ext/autosummary/generate.py

@@ -1,20 +1,15 @@
-"""
+"""Generates reST source files for autosummary.
-    sphinx.ext.autosummary.generate
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    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.
+items referred to in autosummary:: directives.
 
-    Each generated RST file contains a single auto*:: directive which
+Each generated RST file contains a single auto*:: directive which
-    extracts the docstring of the referred item.
+extracts the docstring of the referred item.
 
-    Example Makefile rule::
+Example Makefile rule::
 
-       generate:
+   generate:
-               sphinx-autogen -o source/generated source/*.rst
+           sphinx-autogen -o source/generated source/*.rst
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import argparse

sphinx/ext/coverage.py

@@ -1,12 +1,7 @@
-"""
+"""Check Python modules and C API for coverage.
-    sphinx.ext.coverage
-    ~~~~~~~~~~~~~~~~~~~
 
-    Check Python modules and C API for coverage.  Mostly written by Josip
+Mostly written by Josip Dzolonga for the Google Highly Open Participation
-    Dzolonga for the Google Highly Open Participation contest.
+contest.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import glob

sphinx/ext/doctest.py

@@ -1,12 +1,6 @@
-"""
+"""Mimic doctest in Sphinx.
-    sphinx.ext.doctest
-    ~~~~~~~~~~~~~~~~~~
 
-    Mimic doctest by automatically executing code snippets and checking
+The extension automatically execute code snippets and checks their results.
-    their results.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import doctest

sphinx/ext/duration.py

@@ -1,12 +1,4 @@
-"""
+"""Measure durations of Sphinx processing."""
-    sphinx.ext.duration
-    ~~~~~~~~~~~~~~~~~~~
-
-    Measure durations of Sphinx processing.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from datetime import datetime, timedelta
 from itertools import islice

sphinx/ext/extlinks.py

@@ -1,28 +1,20 @@
-"""
+"""Extension to save typing and prevent hard-coding of base URLs in reST files.
-    sphinx.ext.extlinks
-    ~~~~~~~~~~~~~~~~~~~
 
-    Extension to save typing and prevent hard-coding of base URLs in the reST
+This adds a new config value called ``extlinks`` that is created like this::
-    files.
 
-    This adds a new config value called ``extlinks`` that is created like this::
+   extlinks = {'exmpl': ('https://example.invalid/%s.html', caption), ...}
 
-       extlinks = {'exmpl': ('https://example.invalid/%s.html', caption), ...}
+Now you can use e.g. :exmpl:`foo` in your documents.  This will create a
+link to ``https://example.invalid/foo.html``.  The link caption depends on
+the *caption* value given:
 
-    Now you can use e.g. :exmpl:`foo` in your documents.  This will create a
+- If it is ``None``, the caption will be the full URL.
-    link to ``https://example.invalid/foo.html``.  The link caption depends on
+- If it is a string, it must contain ``%s`` exactly once.  In this case the
-    the *caption* value given:
+  caption will be *caption* with the role content substituted for ``%s``.
 
-    - If it is ``None``, the caption will be the full URL.
+You can also give an explicit caption, e.g. :exmpl:`Foo <foo>`.
-    - If it is a string, it must contain ``%s`` exactly once.  In this case the
-      caption will be *caption* with the role content substituted for ``%s``.
 
-    You can also give an explicit caption, e.g. :exmpl:`Foo <foo>`.
+Both, the url string and the caption string must escape ``%`` as ``%%``.
-
-    Both, the url string and the caption string must escape ``%`` as ``%%``.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import re

sphinx/ext/githubpages.py

@@ -1,12 +1,4 @@
-"""
+"""To publish HTML docs at GitHub Pages, create .nojekyll file."""
-    sphinx.ext.githubpages
-    ~~~~~~~~~~~~~~~~~~~~~~
-
-    To publish HTML docs at GitHub Pages, create .nojekyll file.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import os
 import urllib

sphinx/ext/graphviz.py

@@ -1,12 +1,4 @@
-"""
+"""Allow graphviz-formatted graphs to be included inline in generated documents.
-    sphinx.ext.graphviz
-    ~~~~~~~~~~~~~~~~~~~
-
-    Allow graphviz-formatted graphs to be included in Sphinx-generated
-    documents inline.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import posixpath

sphinx/ext/ifconfig.py

@@ -1,22 +1,17 @@
-"""
+"""Provides the ``ifconfig`` directive.
-    sphinx.ext.ifconfig
-    ~~~~~~~~~~~~~~~~~~~
 
-    Provides the ``ifconfig`` directive that allows to write documentation
+The ``ifconfig`` directive enables writing documentation
-    that is included depending on configuration variables.
+that is included depending on configuration variables.
 
-    Usage::
+Usage::
 
-        .. ifconfig:: releaselevel in ('alpha', 'beta', 'rc')
+    .. ifconfig:: releaselevel in ('alpha', 'beta', 'rc')
 
-           This stuff is only included in the built docs for unstable versions.
+       This stuff is only included in the built docs for unstable versions.
 
-    The argument for ``ifconfig`` is a plain Python expression, evaluated in the
+The argument for ``ifconfig`` is a plain Python expression, evaluated in the
-    namespace of the project configuration (that is, all variables from
+namespace of the project configuration (that is, all variables from
-    ``conf.py`` are available.)
+``conf.py`` are available.)
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 from typing import Any, Dict, List

sphinx/ext/imgconverter.py

@@ -1,12 +1,4 @@
-"""
+"""Image converter extension for Sphinx"""
-    sphinx.ext.imgconverter
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    Image converter extension for Sphinx
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import subprocess
 import sys

sphinx/ext/imgmath.py

@@ -1,12 +1,4 @@
-"""
+"""Render math in HTML via dvipng or dvisvgm."""
-    sphinx.ext.imgmath
-    ~~~~~~~~~~~~~~~~~~
-
-    Render math in HTML via dvipng or dvisvgm.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import posixpath
 import re

sphinx/ext/inheritance_diagram.py

@@ -1,38 +1,31 @@
-r"""
+r"""Defines a docutils directive for inserting inheritance diagrams.
-    sphinx.ext.inheritance_diagram
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    Defines a docutils directive for inserting inheritance diagrams.
+Provide the directive with one or more classes or modules (separated
+by whitespace).  For modules, all of the classes in that module will
+be used.
 
-    Provide the directive with one or more classes or modules (separated
+Example::
-    by whitespace).  For modules, all of the classes in that module will
-    be used.
 
-    Example::
+   Given the following classes:
 
-       Given the following classes:
+   class A: pass
+   class B(A): pass
+   class C(A): pass
+   class D(B, C): pass
+   class E(B): pass
 
-       class A: pass
+   .. inheritance-diagram: D E
-       class B(A): pass
-       class C(A): pass
-       class D(B, C): pass
-       class E(B): pass
 
-       .. inheritance-diagram: D E
+   Produces a graph like the following:
 
-       Produces a graph like the following:
+               A
+              / \
+             B   C
+            / \ /
+           E   D
 
-                   A
+The graph is inserted as a PNG+image map into HTML and a PDF in
-                  / \
+LaTeX.
-                 B   C
-                / \ /
-               E   D
-
-    The graph is inserted as a PNG+image map into HTML and a PDF in
-    LaTeX.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import builtins

sphinx/ext/intersphinx.py

@@ -1,26 +1,19 @@
-"""
+"""Insert links to objects documented in remote Sphinx documentation.
-    sphinx.ext.intersphinx
-    ~~~~~~~~~~~~~~~~~~~~~~
 
-    Insert links to objects documented in remote Sphinx documentation.
+This works as follows:
 
-    This works as follows:
+* Each Sphinx HTML build creates a file named "objects.inv" that contains a
+  mapping from object names to URIs relative to the HTML set's root.
 
-    * Each Sphinx HTML build creates a file named "objects.inv" that contains a
+* Projects using the Intersphinx extension can specify links to such mapping
-      mapping from object names to URIs relative to the HTML set's root.
+  files in the `intersphinx_mapping` config value.  The mapping will then be
+  used to resolve otherwise missing references to objects into links to the
+  other documentation.
 
-    * Projects using the Intersphinx extension can specify links to such mapping
+* By default, the mapping file is assumed to be at the same location as the
-      files in the `intersphinx_mapping` config value.  The mapping will then be
+  rest of the documentation; however, the location of the mapping file can
-      used to resolve otherwise missing references to objects into links to the
+  also be specified individually, e.g. if the docs should be buildable
-      other documentation.
+  without Internet access.
-
-    * By default, the mapping file is assumed to be at the same location as the
-      rest of the documentation; however, the location of the mapping file can
-      also be specified individually, e.g. if the docs should be buildable
-      without Internet access.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import concurrent.futures

sphinx/ext/linkcode.py

@@ -1,12 +1,4 @@
-"""
+"""Add external links to module code in Python object descriptions."""
-    sphinx.ext.linkcode
-    ~~~~~~~~~~~~~~~~~~~
-
-    Add external links to module code in Python object descriptions.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, Set
 

sphinx/ext/mathjax.py

@@ -1,13 +1,8 @@
-"""
+"""Allow `MathJax`_ to be used to display math in Sphinx's HTML writer.
-    sphinx.ext.mathjax
-    ~~~~~~~~~~~~~~~~~~
 
-    Allow `MathJax <https://www.mathjax.org/>`_ to be used to display math in
+This requires the MathJax JavaScript library on your webserver/computer.
-    Sphinx's HTML writer -- requires the MathJax JavaScript library on your
-    webserver/computer.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+.. _MathJax: https://www.mathjax.org/
-    :license: BSD, see LICENSE for details.
 """
 
 import json

sphinx/ext/napoleon/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""Support for NumPy and Google style docstrings."""
-    sphinx.ext.napoleon
-    ~~~~~~~~~~~~~~~~~~~
-
-    Support for NumPy and Google style docstrings.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import Any, Dict, List
 

sphinx/ext/napoleon/docstring.py

@@ -1,14 +1,4 @@
-"""
+"""Classes for docstring parsing and formatting."""
-    sphinx.ext.napoleon.docstring
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-    Classes for docstring parsing and formatting.
-
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import collections
 import inspect

sphinx/ext/napoleon/iterators.py

@@ -1,14 +1,4 @@
-"""
+"""A collection of helpful iterators."""
-    sphinx.ext.napoleon.iterators
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-    A collection of helpful iterators.
-
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import collections
 from typing import Any, Iterable, Optional

sphinx/ext/todo.py

@@ -1,14 +1,8 @@
-"""
+"""Allow todos to be inserted into your documentation.
-    sphinx.ext.todo
-    ~~~~~~~~~~~~~~~
 
-    Allow todos to be inserted into your documentation.  Inclusion of todos can
+Inclusion of todos can be switched of by a configuration variable.
-    be switched of by a configuration variable.  The todolist directive collects
+The todolist directive collects all todos of your project and lists them along
-    all todos of your project and lists them along with a backlink to the
+with a backlink to the original location.
-    original location.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 from typing import Any, Dict, List, Tuple, cast

sphinx/ext/viewcode.py

@@ -1,12 +1,4 @@
-"""
+"""Add links to module code in Python object descriptions."""
-    sphinx.ext.viewcode
-    ~~~~~~~~~~~~~~~~~~~
-
-    Add links to module code in Python object descriptions.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import posixpath
 import traceback

sphinx/extension.py

@@ -1,12 +1,4 @@
-"""
+"""Utilities for Sphinx extensions."""
-    sphinx.extension
-    ~~~~~~~~~~~~~~~~
-
-    Utilities for Sphinx extensions.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from typing import TYPE_CHECKING, Any, Dict
 

sphinx/highlighting.py

@@ -1,12 +1,4 @@
-"""
+"""Highlight code blocks using Pygments."""
-    sphinx.highlighting
-    ~~~~~~~~~~~~~~~~~~~
-
-    Highlight code blocks using Pygments.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from functools import partial
 from importlib import import_module

sphinx/io.py

@@ -1,12 +1,4 @@
-"""
+"""Input/Output files"""
-    sphinx.io
-    ~~~~~~~~~
-
-    Input/Output files
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 import codecs
 from typing import TYPE_CHECKING, Any, List, Type
 

sphinx/jinja2glue.py

@@ -1,12 +1,4 @@
-"""
+"""Glue code for the jinja2 templating engine."""
-    sphinx.jinja2glue
-    ~~~~~~~~~~~~~~~~~
-
-    Glue code for the jinja2 templating engine.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 from os import path
 from pprint import pformat

sphinx/locale/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""Locale utilities."""
-    sphinx.locale
-    ~~~~~~~~~~~~~
-
-    Locale utilities.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import gettext
 import locale

sphinx/parsers.py

@@ -1,12 +1,4 @@
-"""
+"""A Base class for additional parsers."""
-    sphinx.parsers
-    ~~~~~~~~~~~~~~
-
-    A Base class for additional parsers.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import warnings
 from typing import TYPE_CHECKING, Any, Dict, List, Type, Union

sphinx/project.py

@@ -1,12 +1,4 @@
-"""
+"""Utility function and classes for Sphinx projects."""
-    sphinx.project
-    ~~~~~~~~~~~~~~
-
-    Utility function and classes for Sphinx projects.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import os
 from glob import glob

sphinx/pycode/__init__.py

@@ -1,12 +1,4 @@
-"""
+"""Utilities parsing and analyzing Python code."""
-    sphinx.pycode
-    ~~~~~~~~~~~~~
-
-    Utilities parsing and analyzing Python code.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 
 import re
 import tokenize