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

Remove module docstring titles
sphinx-doc · Mar 13, 2022 · b12b39d · b12b39d
2 parents 856b182 + f05a068
commit b12b39d
Show file tree

Hide file tree

Showing 285 changed files with 446 additions and 2,724 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,9 @@
 License for Sphinx
 ==================
 
+Unless otherwise indicated, all code in the Sphinx project is licenced under the
+two clause BSD licence below.
+
 Copyright (c) 2007-2022 by the Sphinx team (see AUTHORS file).
 All rights reserved.
 

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

diff --git a/sphinx/__init__.py b/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.)

diff --git a/sphinx/__main__.py b/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
 

diff --git a/sphinx/addnodes.py b/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
 

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

diff --git a/sphinx/builders/__init__.py b/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

diff --git a/sphinx/builders/_epub_base.py b/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

diff --git a/sphinx/builders/changes.py b/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

diff --git a/sphinx/builders/dirhtml.py b/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

diff --git a/sphinx/builders/dummy.py b/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
 

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

diff --git a/sphinx/builders/gettext.py b/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

diff --git a/sphinx/builders/html/__init__.py b/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

diff --git a/sphinx/builders/html/transforms.py b/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

diff --git a/sphinx/builders/latex/__init__.py b/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

diff --git a/sphinx/builders/latex/constants.py b/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
 

diff --git a/sphinx/builders/latex/nodes.py b/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
 

diff --git a/sphinx/builders/latex/theming.py b/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

diff --git a/sphinx/builders/latex/transforms.py b/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
 

diff --git a/sphinx/builders/latex/util.py b/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
 

diff --git a/sphinx/builders/linkcheck.py b/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

diff --git a/sphinx/builders/manpage.py b/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

diff --git a/sphinx/builders/singlehtml.py b/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

diff --git a/sphinx/builders/texinfo.py b/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

diff --git a/sphinx/builders/text.py b/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

diff --git a/sphinx/builders/xml.py b/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

diff --git a/sphinx/cmd/__init__.py b/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."""