Skip to content

Commit b12b39d

Browse files
tk0miyatk0miya
authored
Merge pull request #10212 from AA-Turner/remove-module-docstring-titles
Remove module docstring titles
2 parents 856b182 + f05a068 commit b12b39d

File tree

285 files changed

+446
-2724
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

285 files changed

+446
-2724
lines changed

‎LICENSE‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
License for Sphinx
22
==================
33

4+
Unless otherwise indicated, all code in the Sphinx project is licenced under the
5+
two clause BSD licence below.
6+
47
Copyright (c) 2007-2022 by the Sphinx team (see AUTHORS file).
58
All rights reserved.
69

‎setup.cfg‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,6 @@ import-order-style = smarkets
3535
per-file-ignores =
3636
tests/*: E501
3737

38-
[flake8:local-plugins]
39-
extension =
40-
X101 = utils.checks:sphinx_has_header
41-
paths =
42-
.
43-
4438
[isort]
4539
line_length = 95
4640

‎sphinx/__init__.py‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
"""
2-
Sphinx
3-
~~~~~~
4-
5-
The Sphinx documentation toolchain.
6-
7-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
"""
1+
"""The Sphinx documentation toolchain."""
102

113
# Keep this file executable as-is in Python 3!
124
# (Otherwise getting the version out of it from setup.py is impossible.)

‎sphinx/__main__.py‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
"""
2-
sphinx.__main__
3-
~~~~~~~~~~~~~~~
4-
5-
The Sphinx documentation toolchain.
6-
7-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
"""
1+
"""The Sphinx documentation toolchain."""
102

113
import sys
124

‎sphinx/addnodes.py‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
"""
2-
sphinx.addnodes
3-
~~~~~~~~~~~~~~~
4-
5-
Additional docutils nodes.
6-
7-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
"""
1+
"""Additional docutils nodes."""
102

113
from typing import TYPE_CHECKING, Any, Dict, List, Sequence
124

‎sphinx/application.py‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
"""
2-
sphinx.application
3-
~~~~~~~~~~~~~~~~~~
4-
5-
Sphinx application class and extensibility interface.
6-
7-
Gracefully adapted from the TextPress system by Armin.
1+
"""Sphinx application class and extensibility interface.
82
9-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
10-
:license: BSD, see LICENSE for details.
3+
Gracefully adapted from the TextPress system by Armin.
114
"""
125

136
import os

‎sphinx/builders/__init__.py‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
"""
2-
sphinx.builders
3-
~~~~~~~~~~~~~~~
4-
5-
Builder superclass for all builders.
6-
7-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
"""
1+
"""Builder superclass for all builders."""
102

113
import pickle
124
import time

‎sphinx/builders/_epub_base.py‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
"""
2-
sphinx.builders._epub_base
3-
~~~~~~~~~~~~~~~~~~~~~~~~~~
4-
5-
Base class of epub2/epub3 builders.
6-
7-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
"""
1+
"""Base class of epub2/epub3 builders."""
102

113
import html
124
import os

‎sphinx/builders/changes.py‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
"""
2-
sphinx.builders.changes
3-
~~~~~~~~~~~~~~~~~~~~~~~
4-
5-
Changelog builder.
6-
7-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
"""
1+
"""Changelog builder."""
102

113
import html
124
from os import path

‎sphinx/builders/dirhtml.py‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
"""
2-
sphinx.builders.dirhtml
3-
~~~~~~~~~~~~~~~~~~~~~~~
4-
5-
Directory HTML builders.
6-
7-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
"""
1+
"""Directory HTML builders."""
102

113
from os import path
124
from typing import Any, Dict

0 commit comments

Comments
 (0)