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

sphinx/__main__.py

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

sphinx/addnodes.py

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

sphinx/application.py

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

sphinx/builders/__init__.py

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

sphinx/builders/_epub_base.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Base class of epub2/epub3 builders."""
 
 import html
 import os

sphinx/builders/changes.py

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

sphinx/builders/dirhtml.py

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

sphinx/builders/dummy.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Do syntax checks, but no writing."""
 
 from typing import Any, Dict, Set
 

sphinx/builders/epub3.py

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

sphinx/builders/gettext.py

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

sphinx/builders/html/__init__.py

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

sphinx/builders/html/transforms.py

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

sphinx/builders/latex/__init__.py

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

sphinx/builders/latex/constants.py

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

sphinx/builders/latex/nodes.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Additional nodes for LaTeX writer."""
 
 from docutils import nodes
 

sphinx/builders/latex/theming.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Theming support for LaTeX builder."""
 
 import configparser
 from os import path

sphinx/builders/latex/transforms.py

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

sphinx/builders/latex/util.py

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

sphinx/builders/linkcheck.py

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

sphinx/builders/manpage.py

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

sphinx/builders/singlehtml.py

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

sphinx/builders/texinfo.py

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

sphinx/builders/text.py

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

sphinx/builders/xml.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Docutils-native XML and pseudo-XML builders."""
 
 from os import path
 from typing import Any, Dict, Iterator, Set, Type, Union

sphinx/cmd/__init__.py

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

sphinx/cmd/build.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Build documentation from a provided source."""
 
 import argparse
 import bdb

sphinx/cmd/make_mode.py

@@ -1,17 +1,10 @@
-"""
-    sphinx.cmd.make_mode
-    ~~~~~~~~~~~~~~~~~~~~
-
-    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.
 
 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 @@
-"""
-    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.
-"""
+"""Quickly setup documentation source to work with Sphinx."""
 
 import argparse
 import locale

sphinx/config.py

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

sphinx/deprecation.py

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

sphinx/directives/__init__.py

@@ -1,12 +1,4 @@
-"""
-    sphinx.directives
-    ~~~~~~~~~~~~~~~~~
-
-    Handlers for additional ReST directives.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Handlers for additional ReST directives."""
 
 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 @@
-"""
-    sphinx.domains
-    ~~~~~~~~~~~~~~
+"""Support for 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.
-
-    :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 @@
-"""
-    sphinx.domains.c
-    ~~~~~~~~~~~~~~~~
-
-    The C language domain.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""The C language domain."""
 
 import re
 from typing import (Any, Callable, Dict, Generator, Iterator, List, Optional, Tuple, TypeVar,

sphinx/domains/changeset.py

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

sphinx/domains/citation.py

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

sphinx/domains/cpp.py

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

sphinx/domains/index.py

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

sphinx/domains/javascript.py

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

sphinx/domains/math.py

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

sphinx/domains/python.py

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

sphinx/domains/rst.py

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

sphinx/domains/std.py

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

sphinx/environment/__init__.py

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

sphinx/environment/adapters/__init__.py

@@ -1,9 +1 @@
-"""
-    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"""

sphinx/environment/adapters/asset.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Assets adapter for sphinx.environment."""
 
 from sphinx.environment import BuildEnvironment
 

sphinx/environment/adapters/indexentries.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Index entries adapters for sphinx.environment."""
 
 import re
 import unicodedata

sphinx/environment/adapters/toctree.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Toctree adapter for sphinx.environment."""
 
 from typing import TYPE_CHECKING, Any, Iterable, List, Optional, cast
 

sphinx/environment/collectors/__init__.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""The data collector components for sphinx.environment."""
 
 from typing import TYPE_CHECKING, Dict, List, Optional, Set
 

sphinx/environment/collectors/asset.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""The image collector for sphinx.environment."""
 
 import os
 from glob import glob

sphinx/environment/collectors/dependencies.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""The dependencies collector components for sphinx.environment."""
 
 import os
 from os import path

sphinx/environment/collectors/metadata.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""The metadata collector components for sphinx.environment."""
 
 from typing import Any, Dict, List, Set, cast
 

sphinx/environment/collectors/title.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""The title collector components for sphinx.environment."""
 
 from typing import Any, Dict, Set
 

sphinx/environment/collectors/toctree.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Toctree collector for sphinx.environment."""
 
 from typing import Any, Dict, List, Set, Tuple, Type, TypeVar, cast
 

sphinx/errors.py

@@ -1,13 +1,4 @@
-"""
-    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.
-"""
+"""Contains SphinxError and a few subclasses."""
 
 from typing import Any
 

sphinx/events.py

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

sphinx/ext/__init__.py

@@ -1,9 +1 @@
-"""
-    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.
-"""
+"""Contains Sphinx features not activated by default."""

sphinx/ext/apidoc.py

@@ -1,6 +1,4 @@
-"""
-    sphinx.ext.apidoc
-    ~~~~~~~~~~~~~~~~~
+"""Creates reST files corresponding to Python modules for code documentation.
 
 Parses a directory tree looking for Python modules and packages and creates
 ReST files appropriately to create code documentation with Sphinx.  It also
@@ -9,9 +7,6 @@
 This is derived from the "sphinx-autopackage" script, which is:
 Copyright 2008 Société des arts technologiques (SAT),
 https://sat.qc.ca/
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import argparse

sphinx/ext/autodoc/__init__.py

@@ -1,13 +1,8 @@
-"""
-    sphinx.ext.autodoc
-    ~~~~~~~~~~~~~~~~~~
+"""Extension to create automatic documentation from code docstrings.
 
 Automatically insert docstrings for functions, classes or whole modules into
 the doctree, thus avoiding duplication between docstrings and documentation
 for those who like elaborate docstrings.
-
-    :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 @@
-"""
-    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.
-"""
+"""The deprecated Documenters for autodoc."""
 
 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 @@
-"""
-    sphinx.ext.autodoc.importer
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Importer utilities for autodoc
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Importer utilities for autodoc"""
 
 import importlib
 import traceback

sphinx/ext/autodoc/mock.py

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

sphinx/ext/autodoc/preserve_defaults.py

@@ -1,12 +1,7 @@
-"""
-    sphinx.ext.autodoc.preserve_defaults
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"""Preserve function defaults.
 
 Preserve the default argument values of function signatures in source code
 and keep them not evaluated for readability.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import ast

sphinx/ext/autodoc/type_comment.py

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

sphinx/ext/autodoc/typehints.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Generating content for autodoc using typehints"""
 
 import re
 from collections import OrderedDict

sphinx/ext/autosectionlabel.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Allow reference sections by :ref: role using its title."""
 
 from typing import Any, Dict, cast
 

sphinx/ext/autosummary/__init__.py

@@ -1,10 +1,7 @@
-"""
-    sphinx.ext.autosummary
-    ~~~~~~~~~~~~~~~~~~~~~~
+"""Extension that adds an autosummary:: directive.
 
-    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.
+The directive can be used to generate function/method/attribute/etc. summary
+lists, similar to those output eg. by Epydoc and other API doc generation tools.
 
 An :autolink: role is also provided.
 
@@ -47,9 +44,6 @@
 The autolink role functions as ``:obj:`` when the name referred can be
 resolved to a Python object, and otherwise it becomes simple emphasis.
 This can be used as the default role to make links 'smart'.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import inspect

sphinx/ext/autosummary/generate.py

@@ -1,6 +1,4 @@
-"""
-    sphinx.ext.autosummary.generate
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"""Generates reST source files for autosummary.
 
 Usable as a library or script to generate automatic RST source files for
 items referred to in autosummary:: directives.
@@ -12,9 +10,6 @@
 
    generate:
            sphinx-autogen -o source/generated source/*.rst
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import argparse

sphinx/ext/coverage.py

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

sphinx/ext/doctest.py

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

sphinx/ext/duration.py

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

sphinx/ext/extlinks.py

@@ -1,9 +1,4 @@
-"""
-    sphinx.ext.extlinks
-    ~~~~~~~~~~~~~~~~~~~
-
-    Extension to save typing and prevent hard-coding of base URLs in the reST
-    files.
+"""Extension to save typing and prevent hard-coding of base URLs in reST files.
 
 This adds a new config value called ``extlinks`` that is created like this::
 
@@ -20,9 +15,6 @@
 You can also give an explicit caption, e.g. :exmpl:`Foo <foo>`.
 
 Both, the url string and the caption string must escape ``%`` as ``%%``.
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 import re

sphinx/ext/githubpages.py

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

sphinx/ext/graphviz.py

@@ -1,12 +1,4 @@
-"""
-    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.
+"""Allow graphviz-formatted graphs to be included inline in generated documents.
 """
 
 import posixpath

sphinx/ext/ifconfig.py

@@ -1,8 +1,6 @@
-"""
-    sphinx.ext.ifconfig
-    ~~~~~~~~~~~~~~~~~~~
+"""Provides the ``ifconfig`` directive.
 
-    Provides the ``ifconfig`` directive that allows to write documentation
+The ``ifconfig`` directive enables writing documentation
 that is included depending on configuration variables.
 
 Usage::
@@ -14,9 +12,6 @@
 The argument for ``ifconfig`` is a plain Python expression, evaluated in the
 namespace of the project configuration (that is, all variables from
 ``conf.py`` are available.)
-
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
 """
 
 from typing import Any, Dict, List

sphinx/ext/imgconverter.py

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

sphinx/ext/imgmath.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Render math in HTML via dvipng or dvisvgm."""
 
 import posixpath
 import re

sphinx/ext/inheritance_diagram.py

@@ -1,8 +1,4 @@
-r"""
-    sphinx.ext.inheritance_diagram
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    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
@@ -30,9 +26,6 @@ r"""
 
 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,8 +1,4 @@
-"""
-    sphinx.ext.intersphinx
-    ~~~~~~~~~~~~~~~~~~~~~~
-
-    Insert links to objects documented in remote Sphinx documentation.
+"""Insert links to objects documented in remote Sphinx documentation.
 
 This works as follows:
 
@@ -18,9 +14,6 @@
   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 @@
-"""
-    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.
-"""
+"""Add external links to module code in Python object descriptions."""
 
 from typing import Any, Dict, Set
 

sphinx/ext/mathjax.py

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

sphinx/ext/napoleon/__init__.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Support for NumPy and Google style docstrings."""
 
 from typing import Any, Dict, List
 

sphinx/ext/napoleon/docstring.py

@@ -1,14 +1,4 @@
-"""
-    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.
-"""
+"""Classes for docstring parsing and formatting."""
 
 import collections
 import inspect

sphinx/ext/napoleon/iterators.py

@@ -1,14 +1,4 @@
-"""
-    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.
-"""
+"""A collection of helpful iterators."""
 
 import collections
 from typing import Any, Iterable, Optional

sphinx/ext/todo.py

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

sphinx/ext/viewcode.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Add links to module code in Python object descriptions."""
 
 import posixpath
 import traceback

sphinx/extension.py

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

sphinx/highlighting.py

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

sphinx/io.py

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

sphinx/jinja2glue.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Glue code for the jinja2 templating engine."""
 
 from os import path
 from pprint import pformat

sphinx/locale/__init__.py

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

sphinx/parsers.py

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

sphinx/project.py

@@ -1,12 +1,4 @@
-"""
-    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.
-"""
+"""Utility function and classes for Sphinx projects."""
 
 import os
 from glob import glob

sphinx/pycode/__init__.py

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