summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Turner <9087854+aa-turner@users.noreply.github.com>2022-02-19 22:44:45 +0000
committerAdam Turner <9087854+aa-turner@users.noreply.github.com>2022-02-19 23:17:29 +0000
commit6b8bccec5977f608f0b1e33f31a4888a2ea0d141 (patch)
tree021d012b719cb4b42f9e1b3720b78773d7eb5a3d
parentb8789b4cb6ca034ed7209b9adc91095b0b9b763c (diff)
downloadsphinx-git-6b8bccec5977f608f0b1e33f31a4888a2ea0d141.tar.gz
Remove module titles in docstrings
-rw-r--r--sphinx/__init__.py3
-rw-r--r--sphinx/__main__.py3
-rw-r--r--sphinx/addnodes.py3
-rw-r--r--sphinx/application.py3
-rw-r--r--sphinx/builders/__init__.py3
-rw-r--r--sphinx/builders/_epub_base.py3
-rw-r--r--sphinx/builders/changes.py3
-rw-r--r--sphinx/builders/dirhtml.py3
-rw-r--r--sphinx/builders/dummy.py3
-rw-r--r--sphinx/builders/epub3.py3
-rw-r--r--sphinx/builders/gettext.py3
-rw-r--r--sphinx/builders/html/__init__.py3
-rw-r--r--sphinx/builders/html/transforms.py3
-rw-r--r--sphinx/builders/latex/__init__.py3
-rw-r--r--sphinx/builders/latex/constants.py3
-rw-r--r--sphinx/builders/latex/nodes.py3
-rw-r--r--sphinx/builders/latex/theming.py3
-rw-r--r--sphinx/builders/latex/transforms.py3
-rw-r--r--sphinx/builders/latex/util.py3
-rw-r--r--sphinx/builders/linkcheck.py3
-rw-r--r--sphinx/builders/manpage.py3
-rw-r--r--sphinx/builders/singlehtml.py3
-rw-r--r--sphinx/builders/texinfo.py3
-rw-r--r--sphinx/builders/text.py3
-rw-r--r--sphinx/builders/xml.py3
-rw-r--r--sphinx/cmd/__init__.py3
-rw-r--r--sphinx/cmd/build.py3
-rw-r--r--sphinx/cmd/make_mode.py3
-rw-r--r--sphinx/cmd/quickstart.py3
-rw-r--r--sphinx/config.py3
-rw-r--r--sphinx/deprecation.py3
-rw-r--r--sphinx/directives/__init__.py3
-rw-r--r--sphinx/directives/code.py3
-rw-r--r--sphinx/directives/other.py3
-rw-r--r--sphinx/directives/patches.py3
-rw-r--r--sphinx/domains/__init__.py3
-rw-r--r--sphinx/domains/c.py3
-rw-r--r--sphinx/domains/changeset.py3
-rw-r--r--sphinx/domains/citation.py3
-rw-r--r--sphinx/domains/cpp.py3
-rw-r--r--sphinx/domains/index.py3
-rw-r--r--sphinx/domains/javascript.py3
-rw-r--r--sphinx/domains/math.py3
-rw-r--r--sphinx/domains/python.py3
-rw-r--r--sphinx/domains/rst.py3
-rw-r--r--sphinx/domains/std.py3
-rw-r--r--sphinx/environment/__init__.py3
-rw-r--r--sphinx/environment/adapters/__init__.py3
-rw-r--r--sphinx/environment/adapters/asset.py3
-rw-r--r--sphinx/environment/adapters/indexentries.py3
-rw-r--r--sphinx/environment/adapters/toctree.py3
-rw-r--r--sphinx/environment/collectors/__init__.py3
-rw-r--r--sphinx/environment/collectors/asset.py3
-rw-r--r--sphinx/environment/collectors/dependencies.py3
-rw-r--r--sphinx/environment/collectors/metadata.py3
-rw-r--r--sphinx/environment/collectors/title.py3
-rw-r--r--sphinx/environment/collectors/toctree.py3
-rw-r--r--sphinx/errors.py3
-rw-r--r--sphinx/events.py3
-rw-r--r--sphinx/ext/__init__.py3
-rw-r--r--sphinx/ext/apidoc.py3
-rw-r--r--sphinx/ext/autodoc/__init__.py3
-rw-r--r--sphinx/ext/autodoc/deprecated.py3
-rw-r--r--sphinx/ext/autodoc/directive.py3
-rw-r--r--sphinx/ext/autodoc/importer.py3
-rw-r--r--sphinx/ext/autodoc/mock.py3
-rw-r--r--sphinx/ext/autodoc/preserve_defaults.py3
-rw-r--r--sphinx/ext/autodoc/type_comment.py3
-rw-r--r--sphinx/ext/autodoc/typehints.py3
-rw-r--r--sphinx/ext/autosectionlabel.py3
-rw-r--r--sphinx/ext/autosummary/__init__.py3
-rw-r--r--sphinx/ext/autosummary/generate.py3
-rw-r--r--sphinx/ext/coverage.py3
-rw-r--r--sphinx/ext/doctest.py3
-rw-r--r--sphinx/ext/duration.py3
-rw-r--r--sphinx/ext/extlinks.py3
-rw-r--r--sphinx/ext/githubpages.py3
-rw-r--r--sphinx/ext/graphviz.py3
-rw-r--r--sphinx/ext/ifconfig.py3
-rw-r--r--sphinx/ext/imgconverter.py3
-rw-r--r--sphinx/ext/imgmath.py3
-rw-r--r--sphinx/ext/inheritance_diagram.py3
-rw-r--r--sphinx/ext/intersphinx.py3
-rw-r--r--sphinx/ext/linkcode.py3
-rw-r--r--sphinx/ext/mathjax.py3
-rw-r--r--sphinx/ext/napoleon/__init__.py3
-rw-r--r--sphinx/ext/napoleon/docstring.py3
-rw-r--r--sphinx/ext/napoleon/iterators.py3
-rw-r--r--sphinx/ext/todo.py3
-rw-r--r--sphinx/ext/viewcode.py3
-rw-r--r--sphinx/extension.py3
-rw-r--r--sphinx/highlighting.py3
-rw-r--r--sphinx/io.py3
-rw-r--r--sphinx/jinja2glue.py3
-rw-r--r--sphinx/locale/__init__.py3
-rw-r--r--sphinx/parsers.py3
-rw-r--r--sphinx/project.py3
-rw-r--r--sphinx/pycode/__init__.py3
-rw-r--r--sphinx/pycode/ast.py3
-rw-r--r--sphinx/pycode/parser.py3
-rw-r--r--sphinx/pygments_styles.py3
-rw-r--r--sphinx/registry.py3
-rw-r--r--sphinx/roles.py3
-rw-r--r--sphinx/search/__init__.py3
-rw-r--r--sphinx/search/da.py3
-rw-r--r--sphinx/search/de.py3
-rw-r--r--sphinx/search/en.py3
-rw-r--r--sphinx/search/es.py3
-rw-r--r--sphinx/search/fi.py3
-rw-r--r--sphinx/search/fr.py3
-rw-r--r--sphinx/search/hu.py3
-rw-r--r--sphinx/search/it.py3
-rw-r--r--sphinx/search/ja.py3
-rw-r--r--sphinx/search/jssplitter.py3
-rw-r--r--sphinx/search/nl.py3
-rw-r--r--sphinx/search/no.py3
-rw-r--r--sphinx/search/pt.py3
-rw-r--r--sphinx/search/ro.py3
-rw-r--r--sphinx/search/ru.py3
-rw-r--r--sphinx/search/sv.py3
-rw-r--r--sphinx/search/tr.py3
-rw-r--r--sphinx/search/zh.py3
-rw-r--r--sphinx/setup_command.py3
-rw-r--r--sphinx/testing/__init__.py3
-rw-r--r--sphinx/testing/comparer.py3
-rw-r--r--sphinx/testing/fixtures.py3
-rw-r--r--sphinx/testing/path.py3
-rw-r--r--sphinx/testing/restructuredtext.py3
-rw-r--r--sphinx/testing/util.py3
-rw-r--r--sphinx/theming.py3
-rw-r--r--sphinx/transforms/__init__.py3
-rw-r--r--sphinx/transforms/compact_bullet_list.py3
-rw-r--r--sphinx/transforms/i18n.py3
-rw-r--r--sphinx/transforms/post_transforms/__init__.py3
-rw-r--r--sphinx/transforms/post_transforms/code.py3
-rw-r--r--sphinx/transforms/post_transforms/images.py3
-rw-r--r--sphinx/transforms/references.py3
-rw-r--r--sphinx/util/__init__.py3
-rw-r--r--sphinx/util/build_phase.py3
-rw-r--r--sphinx/util/cfamily.py3
-rw-r--r--sphinx/util/compat.py3
-rw-r--r--sphinx/util/console.py3
-rw-r--r--sphinx/util/docfields.py3
-rw-r--r--sphinx/util/docstrings.py3
-rw-r--r--sphinx/util/docutils.py3
-rw-r--r--sphinx/util/fileutil.py3
-rw-r--r--sphinx/util/i18n.py3
-rw-r--r--sphinx/util/images.py3
-rw-r--r--sphinx/util/inspect.py3
-rw-r--r--sphinx/util/inventory.py3
-rw-r--r--sphinx/util/jsdump.py3
-rw-r--r--sphinx/util/logging.py3
-rw-r--r--sphinx/util/matching.py3
-rw-r--r--sphinx/util/math.py3
-rw-r--r--sphinx/util/nodes.py3
-rw-r--r--sphinx/util/osutil.py3
-rw-r--r--sphinx/util/parallel.py3
-rw-r--r--sphinx/util/png.py3
-rw-r--r--sphinx/util/pycompat.py3
-rw-r--r--sphinx/util/requests.py3
-rw-r--r--sphinx/util/rst.py3
-rw-r--r--sphinx/util/smartypants.py3
-rw-r--r--sphinx/util/stemmer/__init__.py3
-rw-r--r--sphinx/util/stemmer/porter.py3
-rw-r--r--sphinx/util/tags.py3
-rw-r--r--sphinx/util/template.py3
-rw-r--r--sphinx/util/texescape.py3
-rw-r--r--sphinx/util/typing.py3
-rw-r--r--sphinx/versioning.py3
-rw-r--r--sphinx/writers/__init__.py3
-rw-r--r--sphinx/writers/html.py3
-rw-r--r--sphinx/writers/html5.py3
-rw-r--r--sphinx/writers/latex.py3
-rw-r--r--sphinx/writers/manpage.py3
-rw-r--r--sphinx/writers/texinfo.py3
-rw-r--r--sphinx/writers/text.py3
-rw-r--r--sphinx/writers/xml.py3
-rw-r--r--tests/conftest.py3
-rw-r--r--tests/test_api_translator.py3
-rw-r--r--tests/test_application.py3
-rw-r--r--tests/test_build.py3
-rw-r--r--tests/test_build_changes.py3
-rw-r--r--tests/test_build_dirhtml.py3
-rw-r--r--tests/test_build_epub.py3
-rw-r--r--tests/test_build_gettext.py3
-rw-r--r--tests/test_build_html.py3
-rw-r--r--tests/test_build_latex.py3
-rw-r--r--tests/test_build_linkcheck.py3
-rw-r--r--tests/test_build_manpage.py3
-rw-r--r--tests/test_build_texinfo.py3
-rw-r--r--tests/test_build_text.py3
-rw-r--r--tests/test_builder.py3
-rw-r--r--tests/test_catalogs.py3
-rw-r--r--tests/test_config.py3
-rw-r--r--tests/test_correct_year.py3
-rw-r--r--tests/test_directive_code.py3
-rw-r--r--tests/test_directive_only.py3
-rw-r--r--tests/test_directive_other.py3
-rw-r--r--tests/test_directive_patch.py3
-rw-r--r--tests/test_docutilsconf.py3
-rw-r--r--tests/test_domain_c.py3
-rw-r--r--tests/test_domain_cpp.py3
-rw-r--r--tests/test_domain_js.py3
-rw-r--r--tests/test_domain_py.py3
-rw-r--r--tests/test_domain_rst.py3
-rw-r--r--tests/test_domain_std.py3
-rw-r--r--tests/test_environment.py3
-rw-r--r--tests/test_environment_indexentries.py3
-rw-r--r--tests/test_environment_toctree.py3
-rw-r--r--tests/test_events.py3
-rw-r--r--tests/test_ext_apidoc.py3
-rw-r--r--tests/test_ext_autodoc.py3
-rw-r--r--tests/test_ext_autodoc_autoattribute.py3
-rw-r--r--tests/test_ext_autodoc_autoclass.py3
-rw-r--r--tests/test_ext_autodoc_autodata.py3
-rw-r--r--tests/test_ext_autodoc_autofunction.py3
-rw-r--r--tests/test_ext_autodoc_automodule.py3
-rw-r--r--tests/test_ext_autodoc_autoproperty.py3
-rw-r--r--tests/test_ext_autodoc_configs.py3
-rw-r--r--tests/test_ext_autodoc_events.py3
-rw-r--r--tests/test_ext_autodoc_mock.py3
-rw-r--r--tests/test_ext_autodoc_preserve_defaults.py3
-rw-r--r--tests/test_ext_autodoc_private_members.py3
-rw-r--r--tests/test_ext_autosectionlabel.py3
-rw-r--r--tests/test_ext_autosummary.py3
-rw-r--r--tests/test_ext_coverage.py3
-rw-r--r--tests/test_ext_doctest.py3
-rw-r--r--tests/test_ext_duration.py3
-rw-r--r--tests/test_ext_githubpages.py3
-rw-r--r--tests/test_ext_graphviz.py3
-rw-r--r--tests/test_ext_ifconfig.py3
-rw-r--r--tests/test_ext_imgconverter.py3
-rw-r--r--tests/test_ext_inheritance_diagram.py3
-rw-r--r--tests/test_ext_intersphinx.py3
-rw-r--r--tests/test_ext_math.py3
-rw-r--r--tests/test_ext_napoleon.py3
-rw-r--r--tests/test_ext_napoleon_docstring.py3
-rw-r--r--tests/test_ext_napoleon_iterators.py3
-rw-r--r--tests/test_ext_todo.py3
-rw-r--r--tests/test_ext_viewcode.py3
-rw-r--r--tests/test_extension.py3
-rw-r--r--tests/test_highlighting.py3
-rw-r--r--tests/test_intl.py3
-rw-r--r--tests/test_locale.py3
-rw-r--r--tests/test_markup.py3
-rw-r--r--tests/test_metadata.py3
-rw-r--r--tests/test_parser.py3
-rw-r--r--tests/test_project.py3
-rw-r--r--tests/test_pycode.py3
-rw-r--r--tests/test_pycode_ast.py3
-rw-r--r--tests/test_pycode_parser.py3
-rw-r--r--tests/test_quickstart.py3
-rw-r--r--tests/test_roles.py3
-rw-r--r--tests/test_search.py3
-rw-r--r--tests/test_setup_command.py3
-rw-r--r--tests/test_smartquotes.py3
-rw-r--r--tests/test_templating.py3
-rw-r--r--tests/test_theming.py3
-rw-r--r--tests/test_toctree.py3
-rw-r--r--tests/test_transforms_post_transforms.py3
-rw-r--r--tests/test_transforms_post_transforms_code.py3
-rw-r--r--tests/test_util.py3
-rw-r--r--tests/test_util_docstrings.py3
-rw-r--r--tests/test_util_docutils.py3
-rw-r--r--tests/test_util_fileutil.py3
-rw-r--r--tests/test_util_i18n.py3
-rw-r--r--tests/test_util_images.py3
-rw-r--r--tests/test_util_inspect.py3
-rw-r--r--tests/test_util_inventory.py3
-rw-r--r--tests/test_util_logging.py3
-rw-r--r--tests/test_util_matching.py3
-rw-r--r--tests/test_util_nodes.py3
-rw-r--r--tests/test_util_rst.py3
-rw-r--r--tests/test_util_template.py3
-rw-r--r--tests/test_util_typing.py3
-rw-r--r--tests/test_versioning.py3
-rw-r--r--tests/test_writer_latex.py3
-rw-r--r--utils/checks.py3
-rw-r--r--utils/doclinter.py3
-rw-r--r--utils/jssplitter_generator.py3
280 files changed, 0 insertions, 840 deletions
diff --git a/sphinx/__init__.py b/sphinx/__init__.py
index 8106e63bf..197d678c9 100644
--- a/sphinx/__init__.py
+++ b/sphinx/__init__.py
@@ -1,7 +1,4 @@
"""
- Sphinx
- ~~~~~~
-
The Sphinx documentation toolchain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/__main__.py b/sphinx/__main__.py
index daff05441..2d750a0c2 100644
--- a/sphinx/__main__.py
+++ b/sphinx/__main__.py
@@ -1,7 +1,4 @@
"""
- sphinx.__main__
- ~~~~~~~~~~~~~~~
-
The Sphinx documentation toolchain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py
index af1c8fff2..5f0ea74ee 100644
--- a/sphinx/addnodes.py
+++ b/sphinx/addnodes.py
@@ -1,7 +1,4 @@
"""
- sphinx.addnodes
- ~~~~~~~~~~~~~~~
-
Additional docutils nodes.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/application.py b/sphinx/application.py
index fd8b65b6e..640c14e4e 100644
--- a/sphinx/application.py
+++ b/sphinx/application.py
@@ -1,7 +1,4 @@
"""
- sphinx.application
- ~~~~~~~~~~~~~~~~~~
-
Sphinx application class and extensibility interface.
Gracefully adapted from the TextPress system by Armin.
diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py
index b61cd026d..0fd3649a2 100644
--- a/sphinx/builders/__init__.py
+++ b/sphinx/builders/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders
- ~~~~~~~~~~~~~~~
-
Builder superclass for all builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py
index 3b1891769..1bdaf39ea 100644
--- a/sphinx/builders/_epub_base.py
+++ b/sphinx/builders/_epub_base.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders._epub_base
- ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Base class of epub2/epub3 builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py
index a80e53d9a..84ea55f0d 100644
--- a/sphinx/builders/changes.py
+++ b/sphinx/builders/changes.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.changes
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Changelog builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/dirhtml.py b/sphinx/builders/dirhtml.py
index 82af09be1..5e9218d3f 100644
--- a/sphinx/builders/dirhtml.py
+++ b/sphinx/builders/dirhtml.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.dirhtml
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Directory HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/dummy.py b/sphinx/builders/dummy.py
index cddf8e7b8..083bde2f9 100644
--- a/sphinx/builders/dummy.py
+++ b/sphinx/builders/dummy.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.dummy
- ~~~~~~~~~~~~~~~~~~~~~
-
Do syntax checks, but no writing.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/epub3.py b/sphinx/builders/epub3.py
index b1a3f520e..9f204db2c 100644
--- a/sphinx/builders/epub3.py
+++ b/sphinx/builders/epub3.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.epub3
- ~~~~~~~~~~~~~~~~~~~~~
-
Build epub3 files.
Originally derived from epub.py.
diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py
index f9dac2891..d07a89575 100644
--- a/sphinx/builders/gettext.py
+++ b/sphinx/builders/gettext.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.gettext
- ~~~~~~~~~~~~~~~~~~~~~~~
-
The MessageCatalogBuilder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py
index 9f9c17b3d..e6c5ea5ae 100644
--- a/sphinx/builders/html/__init__.py
+++ b/sphinx/builders/html/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.html
- ~~~~~~~~~~~~~~~~~~~~
-
Several HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/html/transforms.py b/sphinx/builders/html/transforms.py
index ea1d69d12..3f36c195d 100644
--- a/sphinx/builders/html/transforms.py
+++ b/sphinx/builders/html/transforms.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.html.transforms
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Transforms for HTML builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py
index d7156b796..78063eee4 100644
--- a/sphinx/builders/latex/__init__.py
+++ b/sphinx/builders/latex/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.latex
- ~~~~~~~~~~~~~~~~~~~~~
-
LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py
index 25caf1736..1e939a46c 100644
--- a/sphinx/builders/latex/constants.py
+++ b/sphinx/builders/latex/constants.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.latex.constants
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
consntants for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/latex/nodes.py b/sphinx/builders/latex/nodes.py
index 95b5211f5..30c729941 100644
--- a/sphinx/builders/latex/nodes.py
+++ b/sphinx/builders/latex/nodes.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.latex.nodes
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Additional nodes for LaTeX writer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/latex/theming.py b/sphinx/builders/latex/theming.py
index b2e3a4dff..a465cb209 100644
--- a/sphinx/builders/latex/theming.py
+++ b/sphinx/builders/latex/theming.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.latex.theming
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Theming support for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py
index 621c6a7cf..3309b891d 100644
--- a/sphinx/builders/latex/transforms.py
+++ b/sphinx/builders/latex/transforms.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.latex.transforms
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Transforms for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/latex/util.py b/sphinx/builders/latex/util.py
index 6b797c9a2..da1f79653 100644
--- a/sphinx/builders/latex/util.py
+++ b/sphinx/builders/latex/util.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.latex.util
- ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Utilities for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py
index 4f760b8bc..e6621a254 100644
--- a/sphinx/builders/linkcheck.py
+++ b/sphinx/builders/linkcheck.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.linkcheck
- ~~~~~~~~~~~~~~~~~~~~~~~~~
-
The CheckExternalLinksBuilder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py
index c942cfa86..59870809e 100644
--- a/sphinx/builders/manpage.py
+++ b/sphinx/builders/manpage.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.manpage
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Manual pages builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py
index 09db8d2b9..0c4daf8a4 100644
--- a/sphinx/builders/singlehtml.py
+++ b/sphinx/builders/singlehtml.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.singlehtml
- ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Single HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py
index f07cd2516..56448b638 100644
--- a/sphinx/builders/texinfo.py
+++ b/sphinx/builders/texinfo.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.texinfo
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Texinfo builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py
index 6363e11a0..038ae4ba0 100644
--- a/sphinx/builders/text.py
+++ b/sphinx/builders/text.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.text
- ~~~~~~~~~~~~~~~~~~~~
-
Plain-text Sphinx builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py
index c4e066089..873cc34d5 100644
--- a/sphinx/builders/xml.py
+++ b/sphinx/builders/xml.py
@@ -1,7 +1,4 @@
"""
- sphinx.builders.xml
- ~~~~~~~~~~~~~~~~~~~
-
Docutils-native XML and pseudo-XML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/cmd/__init__.py b/sphinx/cmd/__init__.py
index d77014547..717893f69 100644
--- a/sphinx/cmd/__init__.py
+++ b/sphinx/cmd/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.cmd
- ~~~~~~~~~~
-
Modules for command line executables.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py
index 8de24a364..e135cf385 100644
--- a/sphinx/cmd/build.py
+++ b/sphinx/cmd/build.py
@@ -1,7 +1,4 @@
"""
- sphinx.cmd.build
- ~~~~~~~~~~~~~~~~
-
Build documentation from a provided source.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/cmd/make_mode.py b/sphinx/cmd/make_mode.py
index cad0eeabb..a08b673ad 100644
--- a/sphinx/cmd/make_mode.py
+++ b/sphinx/cmd/make_mode.py
@@ -1,7 +1,4 @@
"""
- sphinx.cmd.make_mode
- ~~~~~~~~~~~~~~~~~~~~
-
sphinx-build -M command-line handling.
This replaces the old, platform-dependent and once-generated content
diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py
index 01e7e3b16..c5e3ebb52 100644
--- a/sphinx/cmd/quickstart.py
+++ b/sphinx/cmd/quickstart.py
@@ -1,7 +1,4 @@
"""
- sphinx.cmd.quickstart
- ~~~~~~~~~~~~~~~~~~~~~
-
Quickly setup documentation source to work with Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/config.py b/sphinx/config.py
index 37ca06e1d..32daedcec 100644
--- a/sphinx/config.py
+++ b/sphinx/config.py
@@ -1,7 +1,4 @@
"""
- sphinx.config
- ~~~~~~~~~~~~~
-
Build configuration file handling.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py
index 5b95f8b99..10ff34658 100644
--- a/sphinx/deprecation.py
+++ b/sphinx/deprecation.py
@@ -1,7 +1,4 @@
"""
- sphinx.deprecation
- ~~~~~~~~~~~~~~~~~~
-
Sphinx deprecation classes and utilities.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py
index 90658a904..1b4a992b9 100644
--- a/sphinx/directives/__init__.py
+++ b/sphinx/directives/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.directives
- ~~~~~~~~~~~~~~~~~
-
Handlers for additional ReST directives.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/directives/code.py b/sphinx/directives/code.py
index ddd47e1f8..971a42676 100644
--- a/sphinx/directives/code.py
+++ b/sphinx/directives/code.py
@@ -1,7 +1,4 @@
"""
- sphinx.directives.code
- ~~~~~~~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py
index a14b6e801..efd630262 100644
--- a/sphinx/directives/other.py
+++ b/sphinx/directives/other.py
@@ -1,7 +1,4 @@
"""
- sphinx.directives.other
- ~~~~~~~~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/directives/patches.py b/sphinx/directives/patches.py
index d76bb74c7..209b58893 100644
--- a/sphinx/directives/patches.py
+++ b/sphinx/directives/patches.py
@@ -1,7 +1,4 @@
"""
- sphinx.directives.patches
- ~~~~~~~~~~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py
index 4252baf65..6e702b86e 100644
--- a/sphinx/domains/__init__.py
+++ b/sphinx/domains/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains
- ~~~~~~~~~~~~~~
-
Support for domains, which are groupings of description directives
and roles describing e.g. constructs of one programming language.
diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py
index 5181afb17..c79173e01 100644
--- a/sphinx/domains/c.py
+++ b/sphinx/domains/c.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.c
- ~~~~~~~~~~~~~~~~
-
The C language domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py
index 9db598975..817f35487 100644
--- a/sphinx/domains/changeset.py
+++ b/sphinx/domains/changeset.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.changeset
- ~~~~~~~~~~~~~~~~~~~~~~~~
-
The changeset domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/citation.py b/sphinx/domains/citation.py
index f98abc4d1..a3b5bc04b 100644
--- a/sphinx/domains/citation.py
+++ b/sphinx/domains/citation.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.citation
- ~~~~~~~~~~~~~~~~~~~~~~~
-
The citation domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py
index 4f336a4bf..a9fe0d967 100644
--- a/sphinx/domains/cpp.py
+++ b/sphinx/domains/cpp.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.cpp
- ~~~~~~~~~~~~~~~~~~
-
The C++ language domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/index.py b/sphinx/domains/index.py
index 7dbc1bb5a..961b590f4 100644
--- a/sphinx/domains/index.py
+++ b/sphinx/domains/index.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.index
- ~~~~~~~~~~~~~~~~~~~~
-
The index domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py
index 2095d1d10..5c30c2180 100644
--- a/sphinx/domains/javascript.py
+++ b/sphinx/domains/javascript.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.javascript
- ~~~~~~~~~~~~~~~~~~~~~~~~~
-
The JavaScript domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py
index 7f66a4738..f4db6a6b7 100644
--- a/sphinx/domains/math.py
+++ b/sphinx/domains/math.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.math
- ~~~~~~~~~~~~~~~~~~~
-
The math domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py
index 145b62eda..e927b959d 100644
--- a/sphinx/domains/python.py
+++ b/sphinx/domains/python.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.python
- ~~~~~~~~~~~~~~~~~~~~~
-
The Python domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py
index 0899e02f8..40f69dee3 100644
--- a/sphinx/domains/rst.py
+++ b/sphinx/domains/rst.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.rst
- ~~~~~~~~~~~~~~~~~~
-
The reStructuredText domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py
index e9f75325a..8187abd4b 100644
--- a/sphinx/domains/std.py
+++ b/sphinx/domains/std.py
@@ -1,7 +1,4 @@
"""
- sphinx.domains.std
- ~~~~~~~~~~~~~~~~~~
-
The standard domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py
index 9dde7b407..bbe4bf2b7 100644
--- a/sphinx/environment/__init__.py
+++ b/sphinx/environment/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment
- ~~~~~~~~~~~~~~~~~~
-
Global creation environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/adapters/__init__.py b/sphinx/environment/adapters/__init__.py
index 168bd6ba6..2fd847357 100644
--- a/sphinx/environment/adapters/__init__.py
+++ b/sphinx/environment/adapters/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.adapters
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Sphinx environment adapters
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/adapters/asset.py b/sphinx/environment/adapters/asset.py
index af5f79e96..63e736ff7 100644
--- a/sphinx/environment/adapters/asset.py
+++ b/sphinx/environment/adapters/asset.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.adapters.asset
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Assets adapter for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/adapters/indexentries.py b/sphinx/environment/adapters/indexentries.py
index d13c24042..28d56e1c8 100644
--- a/sphinx/environment/adapters/indexentries.py
+++ b/sphinx/environment/adapters/indexentries.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.adapters.indexentries
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Index entries adapters for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py
index 962e73143..1c27fa705 100644
--- a/sphinx/environment/adapters/toctree.py
+++ b/sphinx/environment/adapters/toctree.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.adapters.toctree
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Toctree adapter for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/collectors/__init__.py b/sphinx/environment/collectors/__init__.py
index ba7c20636..badc0bac0 100644
--- a/sphinx/environment/collectors/__init__.py
+++ b/sphinx/environment/collectors/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.collectors
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
The data collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/collectors/asset.py b/sphinx/environment/collectors/asset.py
index 9530b3bd9..fd51061b9 100644
--- a/sphinx/environment/collectors/asset.py
+++ b/sphinx/environment/collectors/asset.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.collectors.asset
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
The image collector for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/collectors/dependencies.py b/sphinx/environment/collectors/dependencies.py
index 4138c4c15..d1ce80a73 100644
--- a/sphinx/environment/collectors/dependencies.py
+++ b/sphinx/environment/collectors/dependencies.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.collectors.dependencies
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
The dependencies collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/collectors/metadata.py b/sphinx/environment/collectors/metadata.py
index 3165b0389..34bfb49cd 100644
--- a/sphinx/environment/collectors/metadata.py
+++ b/sphinx/environment/collectors/metadata.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.collectors.metadata
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
The metadata collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/collectors/title.py b/sphinx/environment/collectors/title.py
index 8c285f323..1ef53514d 100644
--- a/sphinx/environment/collectors/title.py
+++ b/sphinx/environment/collectors/title.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.collectors.title
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
The title collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/environment/collectors/toctree.py b/sphinx/environment/collectors/toctree.py
index ddc7a0417..dc39ee254 100644
--- a/sphinx/environment/collectors/toctree.py
+++ b/sphinx/environment/collectors/toctree.py
@@ -1,7 +1,4 @@
"""
- sphinx.environment.collectors.toctree
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Toctree collector for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/errors.py b/sphinx/errors.py
index c90dd10d0..f89804c7f 100644
--- a/sphinx/errors.py
+++ b/sphinx/errors.py
@@ -1,7 +1,4 @@
"""
- sphinx.errors
- ~~~~~~~~~~~~~
-
Contains SphinxError and a few subclasses (in an extra module to avoid
circular import problems).
diff --git a/sphinx/events.py b/sphinx/events.py
index 46cea6827..5a95416fc 100644
--- a/sphinx/events.py
+++ b/sphinx/events.py
@@ -1,7 +1,4 @@
"""
- sphinx.events
- ~~~~~~~~~~~~~
-
Sphinx core events.
Gracefully adapted from the TextPress system by Armin.
diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py
index 803691ca3..a97bab5bf 100644
--- a/sphinx/ext/__init__.py
+++ b/sphinx/ext/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext
- ~~~~~~~~~~
-
Contains Sphinx features not activated by default.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py
index 07339d6e6..bb1e582eb 100644
--- a/sphinx/ext/apidoc.py
+++ b/sphinx/ext/apidoc.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.apidoc
- ~~~~~~~~~~~~~~~~~
-
Parses a directory tree looking for Python modules and packages and creates
ReST files appropriately to create code documentation with Sphinx. It also
creates a modules index (named modules.<suffix>).
diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py
index a6d36f61f..6d19e6eee 100644
--- a/sphinx/ext/autodoc/__init__.py
+++ b/sphinx/ext/autodoc/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autodoc
- ~~~~~~~~~~~~~~~~~~
-
Automatically insert docstrings for functions, classes or whole modules into
the doctree, thus avoiding duplication between docstrings and documentation
for those who like elaborate docstrings.
diff --git a/sphinx/ext/autodoc/deprecated.py b/sphinx/ext/autodoc/deprecated.py
index 22c9f46b6..63e2c307b 100644
--- a/sphinx/ext/autodoc/deprecated.py
+++ b/sphinx/ext/autodoc/deprecated.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autodoc.deprecated
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
The deprecated Documenters for autodoc.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py
index 0c040e1ef..a52f1c1a3 100644
--- a/sphinx/ext/autodoc/directive.py
+++ b/sphinx/ext/autodoc/directive.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autodoc.directive
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py
index b1bf28ec8..dfa088f2a 100644
--- a/sphinx/ext/autodoc/importer.py
+++ b/sphinx/ext/autodoc/importer.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autodoc.importer
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Importer utilities for autodoc
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py
index 7bd0b1ea0..759c5bae1 100644
--- a/sphinx/ext/autodoc/mock.py
+++ b/sphinx/ext/autodoc/mock.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autodoc.mock
- ~~~~~~~~~~~~~~~~~~~~~~~
-
mock for autodoc
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/autodoc/preserve_defaults.py b/sphinx/ext/autodoc/preserve_defaults.py
index 8ce16b37a..9b5d76204 100644
--- a/sphinx/ext/autodoc/preserve_defaults.py
+++ b/sphinx/ext/autodoc/preserve_defaults.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autodoc.preserve_defaults
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Preserve the default argument values of function signatures in source code
and keep them not evaluated for readability.
diff --git a/sphinx/ext/autodoc/type_comment.py b/sphinx/ext/autodoc/type_comment.py
index 95ba6f6b7..e4483842d 100644
--- a/sphinx/ext/autodoc/type_comment.py
+++ b/sphinx/ext/autodoc/type_comment.py
@@ -1,7 +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.
diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py
index 6acd99e46..6b4188d22 100644
--- a/sphinx/ext/autodoc/typehints.py
+++ b/sphinx/ext/autodoc/typehints.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autodoc.typehints
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Generating content for autodoc using typehints
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py
index e8efcb076..944d2d4cc 100644
--- a/sphinx/ext/autosectionlabel.py
+++ b/sphinx/ext/autosectionlabel.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autosectionlabel
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Allow reference sections by :ref: role using its title.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py
index 964c0f532..c18a71d70 100644
--- a/sphinx/ext/autosummary/__init__.py
+++ b/sphinx/ext/autosummary/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autosummary
- ~~~~~~~~~~~~~~~~~~~~~~
-
Sphinx extension that adds an autosummary:: directive, which can be
used to generate function/method/attribute/etc. summary lists, similar
to those output eg. by Epydoc and other API doc generation tools.
diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py
index 236865630..ff67a25e8 100644
--- a/sphinx/ext/autosummary/generate.py
+++ b/sphinx/ext/autosummary/generate.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.autosummary.generate
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Usable as a library or script to generate automatic RST source files for
items referred to in autosummary:: directives.
diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py
index 2a7e08f8b..652bc5c0f 100644
--- a/sphinx/ext/coverage.py
+++ b/sphinx/ext/coverage.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.coverage
- ~~~~~~~~~~~~~~~~~~~
-
Check Python modules and C API for coverage. Mostly written by Josip
Dzolonga for the Google Highly Open Participation contest.
diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py
index 490516d63..af6da43e0 100644
--- a/sphinx/ext/doctest.py
+++ b/sphinx/ext/doctest.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.doctest
- ~~~~~~~~~~~~~~~~~~
-
Mimic doctest by automatically executing code snippets and checking
their results.
diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py
index b65703472..6e918b134 100644
--- a/sphinx/ext/duration.py
+++ b/sphinx/ext/duration.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.duration
- ~~~~~~~~~~~~~~~~~~~
-
Measure durations of Sphinx processing.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py
index 8caba8842..58ed9674b 100644
--- a/sphinx/ext/extlinks.py
+++ b/sphinx/ext/extlinks.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.extlinks
- ~~~~~~~~~~~~~~~~~~~
-
Extension to save typing and prevent hard-coding of base URLs in the reST
files.
diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py
index 0ea25ba52..cb2584d8d 100644
--- a/sphinx/ext/githubpages.py
+++ b/sphinx/ext/githubpages.py
@@ -1,7 +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.
diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py
index ad248993d..e5749d143 100644
--- a/sphinx/ext/graphviz.py
+++ b/sphinx/ext/graphviz.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.graphviz
- ~~~~~~~~~~~~~~~~~~~
-
Allow graphviz-formatted graphs to be included in Sphinx-generated
documents inline.
diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py
index 50a2b203f..44f218f3d 100644
--- a/sphinx/ext/ifconfig.py
+++ b/sphinx/ext/ifconfig.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.ifconfig
- ~~~~~~~~~~~~~~~~~~~
-
Provides the ``ifconfig`` directive that allows to write documentation
that is included depending on configuration variables.
diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py
index 5a1653037..2117e7130 100644
--- a/sphinx/ext/imgconverter.py
+++ b/sphinx/ext/imgconverter.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.imgconverter
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Image converter extension for Sphinx
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py
index 189bf8786..bdabc8634 100644
--- a/sphinx/ext/imgmath.py
+++ b/sphinx/ext/imgmath.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.imgmath
- ~~~~~~~~~~~~~~~~~~
-
Render math in HTML via dvipng or dvisvgm.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py
index cf4626c0b..e1fd2a237 100644
--- a/sphinx/ext/inheritance_diagram.py
+++ b/sphinx/ext/inheritance_diagram.py
@@ -1,7 +1,4 @@
r"""
- sphinx.ext.inheritance_diagram
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Defines a docutils directive for inserting inheritance diagrams.
Provide the directive with one or more classes or modules (separated
diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py
index 2f8ab2588..eacc72f85 100644
--- a/sphinx/ext/intersphinx.py
+++ b/sphinx/ext/intersphinx.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.intersphinx
- ~~~~~~~~~~~~~~~~~~~~~~
-
Insert links to objects documented in remote Sphinx documentation.
This works as follows:
diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py
index 6ae828408..d724e3551 100644
--- a/sphinx/ext/linkcode.py
+++ b/sphinx/ext/linkcode.py
@@ -1,7 +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.
diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py
index 7b85799ec..c641b11ea 100644
--- a/sphinx/ext/mathjax.py
+++ b/sphinx/ext/mathjax.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.mathjax
- ~~~~~~~~~~~~~~~~~~
-
Allow `MathJax <https://www.mathjax.org/>`_ to be used to display math in
Sphinx's HTML writer -- requires the MathJax JavaScript library on your
webserver/computer.
diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py
index 7f86b1745..07e165ec6 100644
--- a/sphinx/ext/napoleon/__init__.py
+++ b/sphinx/ext/napoleon/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.napoleon
- ~~~~~~~~~~~~~~~~~~~
-
Support for NumPy and Google style docstrings.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py
index 9b9834cfa..cd68deeff 100644
--- a/sphinx/ext/napoleon/docstring.py
+++ b/sphinx/ext/napoleon/docstring.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.napoleon.docstring
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Classes for docstring parsing and formatting.
diff --git a/sphinx/ext/napoleon/iterators.py b/sphinx/ext/napoleon/iterators.py
index f4d4c2423..b6e549f70 100644
--- a/sphinx/ext/napoleon/iterators.py
+++ b/sphinx/ext/napoleon/iterators.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.napoleon.iterators
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
A collection of helpful iterators.
diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py
index 3b8ba1924..7c1df2c69 100644
--- a/sphinx/ext/todo.py
+++ b/sphinx/ext/todo.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.todo
- ~~~~~~~~~~~~~~~
-
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
diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py
index 54274ac04..5fd6120c0 100644
--- a/sphinx/ext/viewcode.py
+++ b/sphinx/ext/viewcode.py
@@ -1,7 +1,4 @@
"""
- sphinx.ext.viewcode
- ~~~~~~~~~~~~~~~~~~~
-
Add links to module code in Python object descriptions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/extension.py b/sphinx/extension.py
index 890a5d8a7..0188dab17 100644
--- a/sphinx/extension.py
+++ b/sphinx/extension.py
@@ -1,7 +1,4 @@
"""
- sphinx.extension
- ~~~~~~~~~~~~~~~~
-
Utilities for Sphinx extensions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py
index 200f41b33..37e1cdf17 100644
--- a/sphinx/highlighting.py
+++ b/sphinx/highlighting.py
@@ -1,7 +1,4 @@
"""
- sphinx.highlighting
- ~~~~~~~~~~~~~~~~~~~
-
Highlight code blocks using Pygments.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/io.py b/sphinx/io.py
index b52ce094f..7d8bd87a9 100644
--- a/sphinx/io.py
+++ b/sphinx/io.py
@@ -1,7 +1,4 @@
"""
- sphinx.io
- ~~~~~~~~~
-
Input/Output files
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py
index 525a4a994..c61ad8cf8 100644
--- a/sphinx/jinja2glue.py
+++ b/sphinx/jinja2glue.py
@@ -1,7 +1,4 @@
"""
- sphinx.jinja2glue
- ~~~~~~~~~~~~~~~~~
-
Glue code for the jinja2 templating engine.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py
index 5378da0a3..b0e579d3b 100644
--- a/sphinx/locale/__init__.py
+++ b/sphinx/locale/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.locale
- ~~~~~~~~~~~~~
-
Locale utilities.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/parsers.py b/sphinx/parsers.py
index 3204c0a1b..471c27274 100644
--- a/sphinx/parsers.py
+++ b/sphinx/parsers.py
@@ -1,7 +1,4 @@
"""
- sphinx.parsers
- ~~~~~~~~~~~~~~
-
A Base class for additional parsers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/project.py b/sphinx/project.py
index 156a08578..47559d7b8 100644
--- a/sphinx/project.py
+++ b/sphinx/project.py
@@ -1,7 +1,4 @@
"""
- sphinx.project
- ~~~~~~~~~~~~~~
-
Utility function and classes for Sphinx projects.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py
index 681bfa38b..66f506795 100644
--- a/sphinx/pycode/__init__.py
+++ b/sphinx/pycode/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.pycode
- ~~~~~~~~~~~~~
-
Utilities parsing and analyzing Python code.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py
index 9e1d23ccc..07c85bf11 100644
--- a/sphinx/pycode/ast.py
+++ b/sphinx/pycode/ast.py
@@ -1,7 +1,4 @@
"""
- sphinx.pycode.ast
- ~~~~~~~~~~~~~~~~~
-
Helpers for AST (Abstract Syntax Tree).
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py
index 5034fe9d5..2265dd2ac 100644
--- a/sphinx/pycode/parser.py
+++ b/sphinx/pycode/parser.py
@@ -1,7 +1,4 @@
"""
- sphinx.pycode.parser
- ~~~~~~~~~~~~~~~~~~~~
-
Utilities parsing and analyzing Python code.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py
index d81aa2879..37bd872bc 100644
--- a/sphinx/pygments_styles.py
+++ b/sphinx/pygments_styles.py
@@ -1,7 +1,4 @@
"""
- sphinx.pygments_styles
- ~~~~~~~~~~~~~~~~~~~~~~
-
Sphinx theme specific highlighting styles.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/registry.py b/sphinx/registry.py
index 76c30b905..e928bb4db 100644
--- a/sphinx/registry.py
+++ b/sphinx/registry.py
@@ -1,7 +1,4 @@
"""
- sphinx.registry
- ~~~~~~~~~~~~~~~
-
Sphinx component registry.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/roles.py b/sphinx/roles.py
index 09cfac9c7..177b7c61b 100644
--- a/sphinx/roles.py
+++ b/sphinx/roles.py
@@ -1,7 +1,4 @@
"""
- sphinx.roles
- ~~~~~~~~~~~~
-
Handlers for additional ReST roles.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py
index 28f3ea036..c569aa797 100644
--- a/sphinx/search/__init__.py
+++ b/sphinx/search/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.search
- ~~~~~~~~~~~~~
-
Create a full-text search index for offline search.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/da.py b/sphinx/search/da.py
index 6ef91b86f..275555136 100644
--- a/sphinx/search/da.py
+++ b/sphinx/search/da.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.da
- ~~~~~~~~~~~~~~~~
-
Danish search language: includes the JS Danish stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/de.py b/sphinx/search/de.py
index 58ea6942c..af02d12dd 100644
--- a/sphinx/search/de.py
+++ b/sphinx/search/de.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.de
- ~~~~~~~~~~~~~~~~
-
German search language: includes the JS German stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/en.py b/sphinx/search/en.py
index 81ff1ae80..c6667c530 100644
--- a/sphinx/search/en.py
+++ b/sphinx/search/en.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.en
- ~~~~~~~~~~~~~~~~
-
English search language: includes the JS porter stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/es.py b/sphinx/search/es.py
index 137a09063..3026c9fd4 100644
--- a/sphinx/search/es.py
+++ b/sphinx/search/es.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.es
- ~~~~~~~~~~~~~~~~
-
Spanish search language: includes the JS Spanish stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py
index 313ddd158..bda7159f0 100644
--- a/sphinx/search/fi.py
+++ b/sphinx/search/fi.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.fi
- ~~~~~~~~~~~~~~~~
-
Finnish search language: includes the JS Finnish stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py
index eea1fb507..4692a64e3 100644
--- a/sphinx/search/fr.py
+++ b/sphinx/search/fr.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.fr
- ~~~~~~~~~~~~~~~~
-
French search language: includes the JS French stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py
index 365439d92..0d0c28e50 100644
--- a/sphinx/search/hu.py
+++ b/sphinx/search/hu.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.hu
- ~~~~~~~~~~~~~~~~
-
Hungarian search language: includes the JS Hungarian stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/it.py b/sphinx/search/it.py
index da042820f..9ec7768ed 100644
--- a/sphinx/search/it.py
+++ b/sphinx/search/it.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.it
- ~~~~~~~~~~~~~~~~
-
Italian search language: includes the JS Italian stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py
index 1d5ebb605..820de07f1 100644
--- a/sphinx/search/ja.py
+++ b/sphinx/search/ja.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.ja
- ~~~~~~~~~~~~~~~~
-
Japanese search language: includes routine to split words.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/jssplitter.py b/sphinx/search/jssplitter.py
index 4403347ed..13f55a16e 100644
--- a/sphinx/search/jssplitter.py
+++ b/sphinx/search/jssplitter.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.jssplitter
- ~~~~~~~~~~~~~~~~~~~~~~~~
-
Provides Python compatible word splitter to JavaScript
DO NOT EDIT. This is generated by utils/jssplitter_generator.py
diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py
index 744c7f5d8..06c84ce4d 100644
--- a/sphinx/search/nl.py
+++ b/sphinx/search/nl.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.nl
- ~~~~~~~~~~~~~~~~
-
Dutch search language: includes the JS porter stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/no.py b/sphinx/search/no.py
index bff65537f..1208991cb 100644
--- a/sphinx/search/no.py
+++ b/sphinx/search/no.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.no
- ~~~~~~~~~~~~~~~~
-
Norwegian search language: includes the JS Norwegian stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py
index 41c2e6004..46a4bb0d0 100644
--- a/sphinx/search/pt.py
+++ b/sphinx/search/pt.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.pt
- ~~~~~~~~~~~~~~~~
-
Portuguese search language: includes the JS Portuguese stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/ro.py b/sphinx/search/ro.py
index 3736142d2..817c70165 100644
--- a/sphinx/search/ro.py
+++ b/sphinx/search/ro.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.ro
- ~~~~~~~~~~~~~~~~
-
Romanian search language: includes the JS Romanian stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py
index b3c2990be..f2e027592 100644
--- a/sphinx/search/ru.py
+++ b/sphinx/search/ru.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.ru
- ~~~~~~~~~~~~~~~~
-
Russian search language: includes the JS Russian stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py
index 29d2764ef..c7b0fde93 100644
--- a/sphinx/search/sv.py
+++ b/sphinx/search/sv.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.sv
- ~~~~~~~~~~~~~~~~
-
Swedish search language: includes the JS Swedish stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/tr.py b/sphinx/search/tr.py
index 86075291c..c85912337 100644
--- a/sphinx/search/tr.py
+++ b/sphinx/search/tr.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.tr
- ~~~~~~~~~~~~~~~~
-
Turkish search language: includes the JS Turkish stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/search/zh.py b/sphinx/search/zh.py
index 0daa4af2a..276a49a70 100644
--- a/sphinx/search/zh.py
+++ b/sphinx/search/zh.py
@@ -1,7 +1,4 @@
"""
- sphinx.search.zh
- ~~~~~~~~~~~~~~~~
-
Chinese search language: includes routine to split words.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py
index 67b89f1c8..3d9663d0f 100644
--- a/sphinx/setup_command.py
+++ b/sphinx/setup_command.py
@@ -1,7 +1,4 @@
"""
- sphinx.setup_command
- ~~~~~~~~~~~~~~~~~~~~
-
Setuptools/distutils commands to assist the building of sphinx
documentation.
diff --git a/sphinx/testing/__init__.py b/sphinx/testing/__init__.py
index c28c0ce0a..babfde1f5 100644
--- a/sphinx/testing/__init__.py
+++ b/sphinx/testing/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.testing
- ~~~~~~~~~~~~~~
-
Sphinx test utilities
You can require sphinx.testing pytest fixtures in a test module or a conftest
diff --git a/sphinx/testing/comparer.py b/sphinx/testing/comparer.py
index 395fe1f74..577a4d091 100644
--- a/sphinx/testing/comparer.py
+++ b/sphinx/testing/comparer.py
@@ -1,7 +1,4 @@
"""
- sphinx.testing.comparer
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Sphinx test comparer for pytest
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py
index 317933ee7..69233707c 100644
--- a/sphinx/testing/fixtures.py
+++ b/sphinx/testing/fixtures.py
@@ -1,7 +1,4 @@
"""
- sphinx.testing.fixtures
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Sphinx test fixtures for pytest
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/testing/path.py b/sphinx/testing/path.py
index ef3b5c7d0..984e0a01c 100644
--- a/sphinx/testing/path.py
+++ b/sphinx/testing/path.py
@@ -1,7 +1,4 @@
"""
- sphinx.testing.path
- ~~~~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/testing/restructuredtext.py b/sphinx/testing/restructuredtext.py
index 59dcd37aa..aa0ebb354 100644
--- a/sphinx/testing/restructuredtext.py
+++ b/sphinx/testing/restructuredtext.py
@@ -1,7 +1,4 @@
"""
- sphinx.testing.restructuredtext
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py
index d062612cb..197e802ed 100644
--- a/sphinx/testing/util.py
+++ b/sphinx/testing/util.py
@@ -1,7 +1,4 @@
"""
- sphinx.testing.util
- ~~~~~~~~~~~~~~~~~~~
-
Sphinx test suite utilities
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/theming.py b/sphinx/theming.py
index 819cec377..c4cfad77a 100644
--- a/sphinx/theming.py
+++ b/sphinx/theming.py
@@ -1,7 +1,4 @@
"""
- sphinx.theming
- ~~~~~~~~~~~~~~
-
Theming support for HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py
index 26e075a7a..ab23f7b4e 100644
--- a/sphinx/transforms/__init__.py
+++ b/sphinx/transforms/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.transforms
- ~~~~~~~~~~~~~~~~~
-
Docutils transforms used by Sphinx when reading documents.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py
index e39ac97d1..c1dfee0d8 100644
--- a/sphinx/transforms/compact_bullet_list.py
+++ b/sphinx/transforms/compact_bullet_list.py
@@ -1,7 +1,4 @@
"""
- sphinx.transforms.compact_bullet_list
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Docutils transforms used by Sphinx when reading documents.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py
index fb2824fe0..6a80daf08 100644
--- a/sphinx/transforms/i18n.py
+++ b/sphinx/transforms/i18n.py
@@ -1,7 +1,4 @@
"""
- sphinx.transforms.i18n
- ~~~~~~~~~~~~~~~~~~~~~~
-
Docutils transforms used by Sphinx when reading documents.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py
index df2eeecbb..720807118 100644
--- a/sphinx/transforms/post_transforms/__init__.py
+++ b/sphinx/transforms/post_transforms/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.transforms.post_transforms
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Docutils transforms used by Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py
index 55bd56c2e..0deda5ed0 100644
--- a/sphinx/transforms/post_transforms/code.py
+++ b/sphinx/transforms/post_transforms/code.py
@@ -1,7 +1,4 @@
"""
- sphinx.transforms.post_transforms.code
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
transforms for code-blocks.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py
index 1a6d4f6d5..6c265a470 100644
--- a/sphinx/transforms/post_transforms/images.py
+++ b/sphinx/transforms/post_transforms/images.py
@@ -1,7 +1,4 @@
"""
- sphinx.transforms.post_transforms.images
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Docutils transforms used by Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py
index 82e8043bb..b47fb545b 100644
--- a/sphinx/transforms/references.py
+++ b/sphinx/transforms/references.py
@@ -1,7 +1,4 @@
"""
- sphinx.transforms.references
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Docutils transforms used by Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py
index 154bd60c1..554ade0cb 100644
--- a/sphinx/util/__init__.py
+++ b/sphinx/util/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.util
- ~~~~~~~~~~~
-
Utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py
index b8221e5d5..68cdb6a31 100644
--- a/sphinx/util/build_phase.py
+++ b/sphinx/util/build_phase.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.build_phase
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Build phase of Sphinx application.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py
index a86cb6f4b..6b9b05966 100644
--- a/sphinx/util/cfamily.py
+++ b/sphinx/util/cfamily.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.cfamily
- ~~~~~~~~~~~~~~~~~~~
-
Utility functions common to the C and C++ domains.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py
index ae481de9b..0f644b838 100644
--- a/sphinx/util/compat.py
+++ b/sphinx/util/compat.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.compat
- ~~~~~~~~~~~~~~~~~~
-
modules for backward compatibility
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/console.py b/sphinx/util/console.py
index 48b566283..62e4d297e 100644
--- a/sphinx/util/console.py
+++ b/sphinx/util/console.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.console
- ~~~~~~~~~~~~~~~~~~~
-
Format colored console output.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py
index a599c66a7..f81f80948 100644
--- a/sphinx/util/docfields.py
+++ b/sphinx/util/docfields.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.docfields
- ~~~~~~~~~~~~~~~~~~~~~
-
"Doc fields" are reST field lists in object descriptions that will
be domain-specifically transformed to a more appealing presentation.
diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py
index 620edf8c7..f634b438b 100644
--- a/sphinx/util/docstrings.py
+++ b/sphinx/util/docstrings.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.docstrings
- ~~~~~~~~~~~~~~~~~~~~~~
-
Utilities for docstring processing.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py
index 5ab766649..90f00ddd5 100644
--- a/sphinx/util/docutils.py
+++ b/sphinx/util/docutils.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.docutils
- ~~~~~~~~~~~~~~~~~~~~
-
Utility functions for docutils.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py
index c46a81cb6..7e412e2ec 100644
--- a/sphinx/util/fileutil.py
+++ b/sphinx/util/fileutil.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.fileutil
- ~~~~~~~~~~~~~~~~~~~~
-
File utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py
index 511a9abee..0e0621fcd 100644
--- a/sphinx/util/i18n.py
+++ b/sphinx/util/i18n.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.i18n
- ~~~~~~~~~~~~~~~~
-
Builder superclass for all builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/images.py b/sphinx/util/images.py
index 12a253791..508617ca6 100644
--- a/sphinx/util/images.py
+++ b/sphinx/util/images.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.images
- ~~~~~~~~~~~~~~~~~~
-
Image utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py
index 06920288f..9a66c0ec6 100644
--- a/sphinx/util/inspect.py
+++ b/sphinx/util/inspect.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.inspect
- ~~~~~~~~~~~~~~~~~~~
-
Helpers for inspecting Python modules.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py
index a208affec..dfc3cd7ba 100644
--- a/sphinx/util/inventory.py
+++ b/sphinx/util/inventory.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.inventory
- ~~~~~~~~~~~~~~~~~~~~~
-
Inventory utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py
index 7db70dd5c..935a26119 100644
--- a/sphinx/util/jsdump.py
+++ b/sphinx/util/jsdump.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.jsdump
- ~~~~~~~~~~~~~~~~~~
-
This module implements a simple JavaScript serializer.
Uses the basestring encode function from simplejson by Bob Ippolito.
diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py
index 7294885b5..b78707afe 100644
--- a/sphinx/util/logging.py
+++ b/sphinx/util/logging.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.logging
- ~~~~~~~~~~~~~~~~~~~
-
Logging utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py
index a89acf9a8..e8c000ee1 100644
--- a/sphinx/util/matching.py
+++ b/sphinx/util/matching.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.matching
- ~~~~~~~~~~~~~~~~~~~~
-
Pattern-matching utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/math.py b/sphinx/util/math.py
index 664859624..0fa945890 100644
--- a/sphinx/util/math.py
+++ b/sphinx/util/math.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.math
- ~~~~~~~~~~~~~~~~
-
Utility functions for math.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py
index c16142a2c..3af9f4dd7 100644
--- a/sphinx/util/nodes.py
+++ b/sphinx/util/nodes.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.nodes
- ~~~~~~~~~~~~~~~~~
-
Docutils node-related utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py
index 4f69b4f38..e346170f0 100644
--- a/sphinx/util/osutil.py
+++ b/sphinx/util/osutil.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.osutil
- ~~~~~~~~~~~~~~~~~~
-
Operating system-related utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py
index 3f348a8b5..3783db7fc 100644
--- a/sphinx/util/parallel.py
+++ b/sphinx/util/parallel.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.parallel
- ~~~~~~~~~~~~~~~~~~~~
-
Parallel building utilities.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/png.py b/sphinx/util/png.py
index c40f653e6..ba9794f62 100644
--- a/sphinx/util/png.py
+++ b/sphinx/util/png.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.png
- ~~~~~~~~~~~~~~~
-
PNG image manipulation helpers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py
index 2b9b67be9..639ccb5ab 100644
--- a/sphinx/util/pycompat.py
+++ b/sphinx/util/pycompat.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.pycompat
- ~~~~~~~~~~~~~~~~~~~~
-
Stuff for Python version compatibility.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py
index 581efbfd5..78b947ce8 100644
--- a/sphinx/util/requests.py
+++ b/sphinx/util/requests.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.requests
- ~~~~~~~~~~~~~~~~~~~~
-
Simple requests package loader
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py
index 320efa618..3cb9d64ba 100644
--- a/sphinx/util/rst.py
+++ b/sphinx/util/rst.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.rst
- ~~~~~~~~~~~~~~~
-
reST helper functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/smartypants.py b/sphinx/util/smartypants.py
index 05d3b03bf..512ab839a 100644
--- a/sphinx/util/smartypants.py
+++ b/sphinx/util/smartypants.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.smartypants
- ~~~~~~~~~~~~~~~~~~~~~~~
-
This is extracted (with minor adaptations for flake8 compliance) from
docutils’ docutils/utils/smartquotes.py as of revision 8097 (30 May 2017),
in order to backport for Sphinx usage with Docutils < 0.14 extra language
diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py
index 65ef04350..0332e3f3b 100644
--- a/sphinx/util/stemmer/__init__.py
+++ b/sphinx/util/stemmer/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.stemmer
- ~~~~~~~~~~~~~~~~~~~
-
Word stemming utilities for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/stemmer/porter.py b/sphinx/util/stemmer/porter.py
index 52ca31e0c..e26431646 100644
--- a/sphinx/util/stemmer/porter.py
+++ b/sphinx/util/stemmer/porter.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.stemmer.porter
- ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Porter Stemming Algorithm
This is the Porter stemming algorithm, ported to Python from the
diff --git a/sphinx/util/tags.py b/sphinx/util/tags.py
index 67c023643..f5cd52f4d 100644
--- a/sphinx/util/tags.py
+++ b/sphinx/util/tags.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.tags
- ~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/util/template.py b/sphinx/util/template.py
index 5d5de52be..c684b8589 100644
--- a/sphinx/util/template.py
+++ b/sphinx/util/template.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.template
- ~~~~~~~~~~~~~~~~~~~~
-
Templates utility functions for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py
index 7efbb29ae..92b07521f 100644
--- a/sphinx/util/texescape.py
+++ b/sphinx/util/texescape.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.texescape
- ~~~~~~~~~~~~~~~~~~~~~
-
TeX escaping helper.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
index f47788005..df5c9f6e8 100644
--- a/sphinx/util/typing.py
+++ b/sphinx/util/typing.py
@@ -1,7 +1,4 @@
"""
- sphinx.util.typing
- ~~~~~~~~~~~~~~~~~~
-
The composite types for Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/versioning.py b/sphinx/versioning.py
index 1a615101d..09be9aef7 100644
--- a/sphinx/versioning.py
+++ b/sphinx/versioning.py
@@ -1,7 +1,4 @@
"""
- sphinx.versioning
- ~~~~~~~~~~~~~~~~~
-
Implements the low-level algorithms Sphinx uses for the versioning of
doctrees.
diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py
index 0f8451bc9..668ecc0f5 100644
--- a/sphinx/writers/__init__.py
+++ b/sphinx/writers/__init__.py
@@ -1,7 +1,4 @@
"""
- sphinx.writers
- ~~~~~~~~~~~~~~
-
Custom docutils writers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py
index 34b73a0a5..e7efff848 100644
--- a/sphinx/writers/html.py
+++ b/sphinx/writers/html.py
@@ -1,7 +1,4 @@
"""
- sphinx.writers.html
- ~~~~~~~~~~~~~~~~~~~
-
docutils writers handling Sphinx' custom nodes.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py
index b9d0f648c..5324741cd 100644
--- a/sphinx/writers/html5.py
+++ b/sphinx/writers/html5.py
@@ -1,7 +1,4 @@
"""
- sphinx.writers.html5
- ~~~~~~~~~~~~~~~~~~~~
-
Experimental docutils writers for HTML5 handling Sphinx's custom nodes.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py
index 5afc5fca7..7956a854d 100644
--- a/sphinx/writers/latex.py
+++ b/sphinx/writers/latex.py
@@ -1,7 +1,4 @@
"""
- sphinx.writers.latex
- ~~~~~~~~~~~~~~~~~~~~
-
Custom docutils writer for LaTeX.
Much of this code is adapted from Dave Kuhlman's "docpy" writer from his
diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py
index 0344d82e9..be7a405b7 100644
--- a/sphinx/writers/manpage.py
+++ b/sphinx/writers/manpage.py
@@ -1,7 +1,4 @@
"""
- sphinx.writers.manpage
- ~~~~~~~~~~~~~~~~~~~~~~
-
Manual page writer, extended for Sphinx custom nodes.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py
index 7913972a9..7b7af182d 100644
--- a/sphinx/writers/texinfo.py
+++ b/sphinx/writers/texinfo.py
@@ -1,7 +1,4 @@
"""
- sphinx.writers.texinfo
- ~~~~~~~~~~~~~~~~~~~~~~
-
Custom docutils writer for Texinfo.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py
index 9fef050c1..255beb848 100644
--- a/sphinx/writers/text.py
+++ b/sphinx/writers/text.py
@@ -1,7 +1,4 @@
"""
- sphinx.writers.text
- ~~~~~~~~~~~~~~~~~~~
-
Custom docutils writer for plain text.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py
index f9fb22784..733b6b3a2 100644
--- a/sphinx/writers/xml.py
+++ b/sphinx/writers/xml.py
@@ -1,7 +1,4 @@
"""
- sphinx.writers.xml
- ~~~~~~~~~~~~~~~~~~
-
Docutils-native XML and pseudo-XML writers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/conftest.py b/tests/conftest.py
index dd1a04513..d04956fe1 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -1,7 +1,4 @@
"""
- pytest config for sphinx/tests
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py
index dd721355b..303387156 100644
--- a/tests/test_api_translator.py
+++ b/tests/test_api_translator.py
@@ -1,7 +1,4 @@
"""
- test_api_translator
- ~~~~~~~~~~~~~~~~~~~
-
Test the Sphinx API for translator.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_application.py b/tests/test_application.py
index fc85f193d..5eac1f7d0 100644
--- a/tests/test_application.py
+++ b/tests/test_application.py
@@ -1,7 +1,4 @@
"""
- test_application
- ~~~~~~~~~~~~~~~~
-
Test the Sphinx class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build.py b/tests/test_build.py
index 76de332ee..c5a34280d 100644
--- a/tests/test_build.py
+++ b/tests/test_build.py
@@ -1,7 +1,4 @@
"""
- test_build
- ~~~~~~~~~~
-
Test all builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_changes.py b/tests/test_build_changes.py
index 65307ba92..67fe3701d 100644
--- a/tests/test_build_changes.py
+++ b/tests/test_build_changes.py
@@ -1,7 +1,4 @@
"""
- test_build_changes
- ~~~~~~~~~~~~~~~~~~
-
Test the ChangesBuilder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_dirhtml.py b/tests/test_build_dirhtml.py
index a7a90623c..cb3958b7d 100644
--- a/tests/test_build_dirhtml.py
+++ b/tests/test_build_dirhtml.py
@@ -1,7 +1,4 @@
"""
- test_build_dirhtml
- ~~~~~~~~~~~~~~~~~~
-
Test dirhtml builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_epub.py b/tests/test_build_epub.py
index 851e8ac9d..ce2610b7b 100644
--- a/tests/test_build_epub.py
+++ b/tests/test_build_epub.py
@@ -1,7 +1,4 @@
"""
- test_build_html
- ~~~~~~~~~~~~~~~
-
Test the HTML builder and check output against XPath.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py
index 9398dfe5f..fd227a6a6 100644
--- a/tests/test_build_gettext.py
+++ b/tests/test_build_gettext.py
@@ -1,7 +1,4 @@
"""
- test_build_gettext
- ~~~~~~~~~~~~~~~~~~
-
Test the build process with gettext builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_html.py b/tests/test_build_html.py
index 7688f76b3..795e93fac 100644
--- a/tests/test_build_html.py
+++ b/tests/test_build_html.py
@@ -1,7 +1,4 @@
"""
- test_build_html
- ~~~~~~~~~~~~~~~
-
Test the HTML builder and check output against XPath.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py
index b0ae85423..5a3dc1811 100644
--- a/tests/test_build_latex.py
+++ b/tests/test_build_latex.py
@@ -1,7 +1,4 @@
"""
- test_build_latex
- ~~~~~~~~~~~~~~~~
-
Test the build process with LaTeX builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py
index 358db6a4e..f5338020b 100644
--- a/tests/test_build_linkcheck.py
+++ b/tests/test_build_linkcheck.py
@@ -1,7 +1,4 @@
"""
- test_build_linkcheck
- ~~~~~~~~~~~~~~~~~~~~
-
Test the build process with manpage builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_manpage.py b/tests/test_build_manpage.py
index 1a14c9bf7..99b61bb0e 100644
--- a/tests/test_build_manpage.py
+++ b/tests/test_build_manpage.py
@@ -1,7 +1,4 @@
"""
- test_build_manpage
- ~~~~~~~~~~~~~~~~~~
-
Test the build process with manpage builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py
index 601de1587..3de24cfe4 100644
--- a/tests/test_build_texinfo.py
+++ b/tests/test_build_texinfo.py
@@ -1,7 +1,4 @@
"""
- test_build_texinfo
- ~~~~~~~~~~~~~~~~~~
-
Test the build process with Texinfo builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_build_text.py b/tests/test_build_text.py
index c080d2ad2..1b1b507a4 100644
--- a/tests/test_build_text.py
+++ b/tests/test_build_text.py
@@ -1,7 +1,4 @@
"""
- test_build_text
- ~~~~~~~~~~~~~~~
-
Test the build process with Text builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_builder.py b/tests/test_builder.py
index 4927e5d1d..cacea6e22 100644
--- a/tests/test_builder.py
+++ b/tests/test_builder.py
@@ -1,7 +1,4 @@
"""
- test_builder
- ~~~~~~~~
-
Test the Builder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_catalogs.py b/tests/test_catalogs.py
index 319e6a07d..e2c6b9b21 100644
--- a/tests/test_catalogs.py
+++ b/tests/test_catalogs.py
@@ -1,7 +1,4 @@
"""
- test_build_base
- ~~~~~~~~~~~~~~~
-
Test the base build process.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_config.py b/tests/test_config.py
index 97e911eb5..f64b912c4 100644
--- a/tests/test_config.py
+++ b/tests/test_config.py
@@ -1,7 +1,4 @@
"""
- test_config
- ~~~~~~~~~~~
-
Test the sphinx.config.Config class and its handling in the
Application class.
diff --git a/tests/test_correct_year.py b/tests/test_correct_year.py
index bcb217036..5c219df1d 100644
--- a/tests/test_correct_year.py
+++ b/tests/test_correct_year.py
@@ -1,7 +1,4 @@
"""
- test_correct_year
- ~~~~~~~~~~~~~~~~~
-
Test copyright year adjustment
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_directive_code.py b/tests/test_directive_code.py
index 5f519d3b9..e7a9d4505 100644
--- a/tests/test_directive_code.py
+++ b/tests/test_directive_code.py
@@ -1,7 +1,4 @@
"""
- test_directive_code
- ~~~~~~~~~~~~~~~~~~~
-
Test the code-block directive.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_directive_only.py b/tests/test_directive_only.py
index 164220e33..29ea531b8 100644
--- a/tests/test_directive_only.py
+++ b/tests/test_directive_only.py
@@ -1,7 +1,4 @@
"""
- test_only_directive
- ~~~~~~~~~~~~~~~~~~~
-
Test the only directive with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_directive_other.py b/tests/test_directive_other.py
index e1858f4e0..78118c10a 100644
--- a/tests/test_directive_other.py
+++ b/tests/test_directive_other.py
@@ -1,7 +1,4 @@
"""
- test_directive_other
- ~~~~~~~~~~~~~~~~~~~~
-
Test the other directives.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_directive_patch.py b/tests/test_directive_patch.py
index a199a89db..03f86f61b 100644
--- a/tests/test_directive_patch.py
+++ b/tests/test_directive_patch.py
@@ -1,7 +1,4 @@
"""
- test_directive_patch
- ~~~~~~~~~~~~~~~~~~~
-
Test the patched directives.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py
index 7e47c9ab3..342b3180b 100644
--- a/tests/test_docutilsconf.py
+++ b/tests/test_docutilsconf.py
@@ -1,7 +1,4 @@
"""
- test_docutilsconf
- ~~~~~~~~~~~~~~~~~
-
Test docutils.conf support for several writers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_domain_c.py b/tests/test_domain_c.py
index f69008b8f..d386eb81b 100644
--- a/tests/test_domain_c.py
+++ b/tests/test_domain_c.py
@@ -1,7 +1,4 @@
"""
- test_domain_c
- ~~~~~~~~~~~~~
-
Tests the C Domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py
index 8fc974f49..6239228e1 100644
--- a/tests/test_domain_cpp.py
+++ b/tests/test_domain_cpp.py
@@ -1,7 +1,4 @@
"""
- test_domain_cpp
- ~~~~~~~~~~~~~~~
-
Tests the C++ Domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_domain_js.py b/tests/test_domain_js.py
index b109fe4d8..592360781 100644
--- a/tests/test_domain_js.py
+++ b/tests/test_domain_js.py
@@ -1,7 +1,4 @@
"""
- test_domain_js
- ~~~~~~~~~~~~~~
-
Tests the JavaScript Domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py
index de544d25d..3ffc3f372 100644
--- a/tests/test_domain_py.py
+++ b/tests/test_domain_py.py
@@ -1,7 +1,4 @@
"""
- test_domain_py
- ~~~~~~~~~~~~~~
-
Tests the Python Domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_domain_rst.py b/tests/test_domain_rst.py
index b79431d49..231aa6317 100644
--- a/tests/test_domain_rst.py
+++ b/tests/test_domain_rst.py
@@ -1,7 +1,4 @@
"""
- test_rst_domain
- ~~~~~~~~~~~~~~~
-
Tests the reStructuredText domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py
index 00e7361a3..5b5f87ff5 100644
--- a/tests/test_domain_std.py
+++ b/tests/test_domain_std.py
@@ -1,7 +1,4 @@
"""
- test_domain_std
- ~~~~~~~~~~~~~~~
-
Tests the std domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_environment.py b/tests/test_environment.py
index d8eec2c05..73ea690fa 100644
--- a/tests/test_environment.py
+++ b/tests/test_environment.py
@@ -1,7 +1,4 @@
"""
- test_env
- ~~~~~~~~
-
Test the BuildEnvironment class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_environment_indexentries.py b/tests/test_environment_indexentries.py
index f32592f9f..505b45e8f 100644
--- a/tests/test_environment_indexentries.py
+++ b/tests/test_environment_indexentries.py
@@ -1,7 +1,4 @@
"""
- test_environment_indexentries
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the sphinx.environment.managers.indexentries.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py
index dc5a184a4..a2a6a3ed9 100644
--- a/tests/test_environment_toctree.py
+++ b/tests/test_environment_toctree.py
@@ -1,7 +1,4 @@
"""
- test_environment_toctree
- ~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the sphinx.environment.managers.toctree.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_events.py b/tests/test_events.py
index 44b0526d1..74649a869 100644
--- a/tests/test_events.py
+++ b/tests/test_events.py
@@ -1,7 +1,4 @@
"""
- test_events
- ~~~~~~~~~~~
-
Test the EventManager class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py
index 44c3308fe..4e4f8d89e 100644
--- a/tests/test_ext_apidoc.py
+++ b/tests/test_ext_apidoc.py
@@ -1,7 +1,4 @@
"""
- test_apidoc
- ~~~~~~~~~~~
-
Test the sphinx.apidoc module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py
index 62bbf83d0..3f48beb7a 100644
--- a/tests/test_ext_autodoc.py
+++ b/tests/test_ext_autodoc.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc
- ~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
diff --git a/tests/test_ext_autodoc_autoattribute.py b/tests/test_ext_autodoc_autoattribute.py
index fec4da463..1907389d3 100644
--- a/tests/test_ext_autodoc_autoattribute.py
+++ b/tests/test_ext_autodoc_autoattribute.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_autoattribute
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
diff --git a/tests/test_ext_autodoc_autoclass.py b/tests/test_ext_autodoc_autoclass.py
index e68c72a58..fd90a7cab 100644
--- a/tests/test_ext_autodoc_autoclass.py
+++ b/tests/test_ext_autodoc_autoclass.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_autoclass
- ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
diff --git a/tests/test_ext_autodoc_autodata.py b/tests/test_ext_autodoc_autodata.py
index 7d6d9eb30..7462e6182 100644
--- a/tests/test_ext_autodoc_autodata.py
+++ b/tests/test_ext_autodoc_autodata.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_autodata
- ~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
diff --git a/tests/test_ext_autodoc_autofunction.py b/tests/test_ext_autodoc_autofunction.py
index 6489626d2..30586e08c 100644
--- a/tests/test_ext_autodoc_autofunction.py
+++ b/tests/test_ext_autodoc_autofunction.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_autofunction
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
diff --git a/tests/test_ext_autodoc_automodule.py b/tests/test_ext_autodoc_automodule.py
index 05a73ac81..8aec1fb48 100644
--- a/tests/test_ext_autodoc_automodule.py
+++ b/tests/test_ext_autodoc_automodule.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_autocmodule
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
diff --git a/tests/test_ext_autodoc_autoproperty.py b/tests/test_ext_autodoc_autoproperty.py
index 4b62165e3..b967d65b8 100644
--- a/tests/test_ext_autodoc_autoproperty.py
+++ b/tests/test_ext_autodoc_autoproperty.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_autoproperty
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
diff --git a/tests/test_ext_autodoc_configs.py b/tests/test_ext_autodoc_configs.py
index e84e360e8..ce4f0e064 100644
--- a/tests/test_ext_autodoc_configs.py
+++ b/tests/test_ext_autodoc_configs.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_configs
- ~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly for config variables
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_autodoc_events.py b/tests/test_ext_autodoc_events.py
index 6a71054c2..0adb0d6a1 100644
--- a/tests/test_ext_autodoc_events.py
+++ b/tests/test_ext_autodoc_events.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_events
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly for autodoc events
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_autodoc_mock.py b/tests/test_ext_autodoc_mock.py
index c207c82fc..1a7a39aa0 100644
--- a/tests/test_ext_autodoc_mock.py
+++ b/tests/test_ext_autodoc_mock.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_mock
- ~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_autodoc_preserve_defaults.py b/tests/test_ext_autodoc_preserve_defaults.py
index a7a24e026..54c26e226 100644
--- a/tests/test_ext_autodoc_preserve_defaults.py
+++ b/tests/test_ext_autodoc_preserve_defaults.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_preserve_defaults
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_autodoc_private_members.py b/tests/test_ext_autodoc_private_members.py
index f685f774c..dbb8f759b 100644
--- a/tests/test_ext_autodoc_private_members.py
+++ b/tests/test_ext_autodoc_private_members.py
@@ -1,7 +1,4 @@
"""
- test_ext_autodoc_private_members
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test the autodoc extension. This tests mainly for private-members option.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_autosectionlabel.py b/tests/test_ext_autosectionlabel.py
index ccbc9ed77..307439e99 100644
--- a/tests/test_ext_autosectionlabel.py
+++ b/tests/test_ext_autosectionlabel.py
@@ -1,7 +1,4 @@
"""
- test_ext_autosectionlabel
- ~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test sphinx.ext.autosectionlabel extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py
index 13da15e50..3bc4d3bd9 100644
--- a/tests/test_ext_autosummary.py
+++ b/tests/test_ext_autosummary.py
@@ -1,7 +1,4 @@
"""
- test_autosummary
- ~~~~~~~~~~~~~~~~
-
Test the autosummary extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_coverage.py b/tests/test_ext_coverage.py
index 6d6fbcf1d..4c2e799bd 100644
--- a/tests/test_ext_coverage.py
+++ b/tests/test_ext_coverage.py
@@ -1,7 +1,4 @@
"""
- test_coverage
- ~~~~~~~~~~~~~
-
Test the coverage builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py
index 3a527acb2..dbda96c15 100644
--- a/tests/test_ext_doctest.py
+++ b/tests/test_ext_doctest.py
@@ -1,7 +1,4 @@
"""
- test_doctest
- ~~~~~~~~~~~~
-
Test the doctest extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_duration.py b/tests/test_ext_duration.py
index b16cbc4f4..c1f2ca96e 100644
--- a/tests/test_ext_duration.py
+++ b/tests/test_ext_duration.py
@@ -1,7 +1,4 @@
"""
- test_ext_duration
- ~~~~~~~~~~~~~~~~~
-
Test sphinx.ext.duration extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_githubpages.py b/tests/test_ext_githubpages.py
index 9d87b0212..3b63a2c2e 100644
--- a/tests/test_ext_githubpages.py
+++ b/tests/test_ext_githubpages.py
@@ -1,7 +1,4 @@
"""
- test_ext_githubpages
- ~~~~~~~~~~~~~~~~~~~~
-
Test sphinx.ext.githubpages extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py
index 15eaf6050..f916fb1b9 100644
--- a/tests/test_ext_graphviz.py
+++ b/tests/test_ext_graphviz.py
@@ -1,7 +1,4 @@
"""
- test_ext_graphviz
- ~~~~~~~~~~~~~~~~~
-
Test sphinx.ext.graphviz extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_ifconfig.py b/tests/test_ext_ifconfig.py
index f8f897149..4bc7f519f 100644
--- a/tests/test_ext_ifconfig.py
+++ b/tests/test_ext_ifconfig.py
@@ -1,7 +1,4 @@
"""
- test_ext_ifconfig
- ~~~~~~~~~~~~~~~~~
-
Test sphinx.ext.ifconfig extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_imgconverter.py b/tests/test_ext_imgconverter.py
index b4dbf125b..478bf8df4 100644
--- a/tests/test_ext_imgconverter.py
+++ b/tests/test_ext_imgconverter.py
@@ -1,7 +1,4 @@
"""
- test_ext_imgconverter
- ~~~~~~~~~~~~~~~~~~~~~
-
Test sphinx.ext.imgconverter extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py
index bd563b4fc..ad594c2eb 100644
--- a/tests/test_ext_inheritance_diagram.py
+++ b/tests/test_ext_inheritance_diagram.py
@@ -1,7 +1,4 @@
"""
- test_ext_inheritance_diagram
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Test sphinx.ext.inheritance_diagram extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py
index b2ad8afe5..21ce6f952 100644
--- a/tests/test_ext_intersphinx.py
+++ b/tests/test_ext_intersphinx.py
@@ -1,7 +1,4 @@
"""
- test_intersphinx
- ~~~~~~~~~~~~~~~~
-
Test the intersphinx extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py
index 5dd713961..20fc75279 100644
--- a/tests/test_ext_math.py
+++ b/tests/test_ext_math.py
@@ -1,7 +1,4 @@
"""
- test_ext_math
- ~~~~~~~~~~~~~
-
Test math extensions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_napoleon.py b/tests/test_ext_napoleon.py
index 250fdae26..75894f9c0 100644
--- a/tests/test_ext_napoleon.py
+++ b/tests/test_ext_napoleon.py
@@ -1,7 +1,4 @@
"""
- test_napoleon
- ~~~~~~~~~~~~~
-
Tests for :mod:`sphinx.ext.napoleon.__init__` module.
diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py
index 21278dbca..eb2252fb9 100644
--- a/tests/test_ext_napoleon_docstring.py
+++ b/tests/test_ext_napoleon_docstring.py
@@ -1,7 +1,4 @@
"""
- test_napoleon_docstring
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Tests for :mod:`sphinx.ext.napoleon.docstring` module.
diff --git a/tests/test_ext_napoleon_iterators.py b/tests/test_ext_napoleon_iterators.py
index 95c2778e8..0ccc94a06 100644
--- a/tests/test_ext_napoleon_iterators.py
+++ b/tests/test_ext_napoleon_iterators.py
@@ -1,7 +1,4 @@
"""
- test_napoleon_iterators
- ~~~~~~~~~~~~~~~~~~~~~~~
-
Tests for :mod:`sphinx.ext.napoleon.iterators` module.
diff --git a/tests/test_ext_todo.py b/tests/test_ext_todo.py
index 3bc2abadf..010b66034 100644
--- a/tests/test_ext_todo.py
+++ b/tests/test_ext_todo.py
@@ -1,7 +1,4 @@
"""
- test_ext_todo
- ~~~~~~~~~~~~~
-
Test sphinx.ext.todo extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py
index 140b2a728..5b416d14d 100644
--- a/tests/test_ext_viewcode.py
+++ b/tests/test_ext_viewcode.py
@@ -1,7 +1,4 @@
"""
- test_ext_viewcode
- ~~~~~~~~~~~~~~~~~
-
Test sphinx.ext.viewcode extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_extension.py b/tests/test_extension.py
index 4e7fffffa..0955dc382 100644
--- a/tests/test_extension.py
+++ b/tests/test_extension.py
@@ -1,7 +1,4 @@
"""
- test_extension
- ~~~~~~~~~~~~~~
-
Test sphinx.extension module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py
index d83f2f1cc..4238882df 100644
--- a/tests/test_highlighting.py
+++ b/tests/test_highlighting.py
@@ -1,7 +1,4 @@
"""
- test_highlighting
- ~~~~~~~~~~~~~~~~~
-
Test the Pygments highlighting bridge.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_intl.py b/tests/test_intl.py
index 62dbb1352..c89df5732 100644
--- a/tests/test_intl.py
+++ b/tests/test_intl.py
@@ -1,7 +1,4 @@
"""
- test_intl
- ~~~~~~~~~
-
Test message patching for internationalization purposes. Runs the text
builder in the test root.
diff --git a/tests/test_locale.py b/tests/test_locale.py
index c5765ccdf..aadac7b8f 100644
--- a/tests/test_locale.py
+++ b/tests/test_locale.py
@@ -1,7 +1,4 @@
"""
- test_locale
- ~~~~~~~~~~
-
Test locale.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_markup.py b/tests/test_markup.py
index dbd0f0272..a2ffbf17e 100644
--- a/tests/test_markup.py
+++ b/tests/test_markup.py
@@ -1,7 +1,4 @@
"""
- test_markup
- ~~~~~~~~~~~
-
Test various Sphinx-specific markup extensions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_metadata.py b/tests/test_metadata.py
index a2e26a42b..86a9896bf 100644
--- a/tests/test_metadata.py
+++ b/tests/test_metadata.py
@@ -1,7 +1,4 @@
"""
- test_metadata
- ~~~~~~~~~~~~~
-
Test our handling of metadata in files with bibliographic metadata.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_parser.py b/tests/test_parser.py
index cbe9a61df..8098c74af 100644
--- a/tests/test_parser.py
+++ b/tests/test_parser.py
@@ -1,7 +1,4 @@
"""
- test_sphinx_parsers
- ~~~~~~~~~~~~~~~~~~~
-
Tests parsers module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_project.py b/tests/test_project.py
index dc7f1d35d..6996e8202 100644
--- a/tests/test_project.py
+++ b/tests/test_project.py
@@ -1,7 +1,4 @@
"""
- test_project
- ~~~~~~~~~~~~
-
Tests project module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_pycode.py b/tests/test_pycode.py
index 312c0245d..267395a21 100644
--- a/tests/test_pycode.py
+++ b/tests/test_pycode.py
@@ -1,7 +1,4 @@
"""
- test_pycode
- ~~~~~~~~~~~
-
Test pycode.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_pycode_ast.py b/tests/test_pycode_ast.py
index 0de03d5ea..d1150e3b0 100644
--- a/tests/test_pycode_ast.py
+++ b/tests/test_pycode_ast.py
@@ -1,7 +1,4 @@
"""
- test_pycode_ast
- ~~~~~~~~~~~~~~~
-
Test pycode.ast
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_pycode_parser.py b/tests/test_pycode_parser.py
index 11e47a86b..264636907 100644
--- a/tests/test_pycode_parser.py
+++ b/tests/test_pycode_parser.py
@@ -1,7 +1,4 @@
"""
- test_pycode_parser
- ~~~~~~~~~~~~~~~~~~
-
Test pycode.parser.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py
index 0f317c5a8..940897b5b 100644
--- a/tests/test_quickstart.py
+++ b/tests/test_quickstart.py
@@ -1,7 +1,4 @@
"""
- test_quickstart
- ~~~~~~~~~~~~~~~
-
Test the sphinx.quickstart module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_roles.py b/tests/test_roles.py
index a7e936376..b531c7d8b 100644
--- a/tests/test_roles.py
+++ b/tests/test_roles.py
@@ -1,7 +1,4 @@
"""
- test_roles
- ~~~~~~~~~~
-
Test sphinx.roles
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_search.py b/tests/test_search.py
index 4c74ac24a..e2cac35c1 100644
--- a/tests/test_search.py
+++ b/tests/test_search.py
@@ -1,7 +1,4 @@
"""
- test_search
- ~~~~~~~~~~~
-
Test the search index builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py
index 0a1176ae6..41571a2c1 100644
--- a/tests/test_setup_command.py
+++ b/tests/test_setup_command.py
@@ -1,7 +1,4 @@
"""
- test_setup_command
- ~~~~~~~~~~~~~~~~~~~
-
Test setup_command for distutils.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_smartquotes.py b/tests/test_smartquotes.py
index bd8216167..78f0faae8 100644
--- a/tests/test_smartquotes.py
+++ b/tests/test_smartquotes.py
@@ -1,7 +1,4 @@
"""
- test_smartquotes
- ~~~~~~~~~~~~~~~~
-
Test smart quotes.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_templating.py b/tests/test_templating.py
index 37e280c3b..1def07050 100644
--- a/tests/test_templating.py
+++ b/tests/test_templating.py
@@ -1,7 +1,4 @@
"""
- test_templating
- ~~~~~~~~~~~~~~~~
-
Test templating.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_theming.py b/tests/test_theming.py
index 60dd72cdf..b760671bc 100644
--- a/tests/test_theming.py
+++ b/tests/test_theming.py
@@ -1,7 +1,4 @@
"""
- test_theming
- ~~~~~~~~~~~~
-
Test the Theme class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_toctree.py b/tests/test_toctree.py
index 33e73c98c..62f561d87 100644
--- a/tests/test_toctree.py
+++ b/tests/test_toctree.py
@@ -1,7 +1,4 @@
"""
- test_toctree
- ~~~~~~~~~~~~
-
Test the HTML builder and check output against XPath.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_transforms_post_transforms.py b/tests/test_transforms_post_transforms.py
index fe0a7b06b..c3e7613fe 100644
--- a/tests/test_transforms_post_transforms.py
+++ b/tests/test_transforms_post_transforms.py
@@ -1,7 +1,4 @@
"""
- test_transforms_post_transforms
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Tests the post_transforms
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_transforms_post_transforms_code.py b/tests/test_transforms_post_transforms_code.py
index 11369d2ba..c890df294 100644
--- a/tests/test_transforms_post_transforms_code.py
+++ b/tests/test_transforms_post_transforms_code.py
@@ -1,7 +1,4 @@
"""
- test_transforms_post_transforms_code
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/tests/test_util.py b/tests/test_util.py
index 0023bbcdb..ade5d36f9 100644
--- a/tests/test_util.py
+++ b/tests/test_util.py
@@ -1,7 +1,4 @@
"""
- test_util
- ~~~~~~~~~~~~~~~
-
Tests util functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_docstrings.py b/tests/test_util_docstrings.py
index 73f155cf3..fe8727e66 100644
--- a/tests/test_util_docstrings.py
+++ b/tests/test_util_docstrings.py
@@ -1,7 +1,4 @@
"""
- test_util_docstrings
- ~~~~~~~~~~~~~~~~~~~~
-
Test sphinx.util.docstrings.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_docutils.py b/tests/test_util_docutils.py
index 9a7a05e49..2ee8953a7 100644
--- a/tests/test_util_docutils.py
+++ b/tests/test_util_docutils.py
@@ -1,7 +1,4 @@
"""
- test_util_docutils
- ~~~~~~~~~~~~~~~~~~
-
Tests util.utils functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_fileutil.py b/tests/test_util_fileutil.py
index 4d6edd0ce..90264a945 100644
--- a/tests/test_util_fileutil.py
+++ b/tests/test_util_fileutil.py
@@ -1,7 +1,4 @@
"""
- test_util_fileutil
- ~~~~~~~~~~~~~~~~~~
-
Tests sphinx.util.fileutil functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_i18n.py b/tests/test_util_i18n.py
index 3f4e8d52a..fd67446ae 100644
--- a/tests/test_util_i18n.py
+++ b/tests/test_util_i18n.py
@@ -1,7 +1,4 @@
"""
- test_util_i18n
- ~~~~~~~~~~~~~~
-
Test i18n util.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_images.py b/tests/test_util_images.py
index e2c0c61f0..5dbe2a8ed 100644
--- a/tests/test_util_images.py
+++ b/tests/test_util_images.py
@@ -1,7 +1,4 @@
"""
- test_util_images
- ~~~~~~~~~~~~~~~~
-
Test images util.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py
index 9e570da76..18abbe86c 100644
--- a/tests/test_util_inspect.py
+++ b/tests/test_util_inspect.py
@@ -1,7 +1,4 @@
"""
- test_util_inspect
- ~~~~~~~~~~~~~~~
-
Tests util.inspect functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_inventory.py b/tests/test_util_inventory.py
index 305ef4353..d621fd17d 100644
--- a/tests/test_util_inventory.py
+++ b/tests/test_util_inventory.py
@@ -1,7 +1,4 @@
"""
- test_util_inventory
- ~~~~~~~~~~~~~~~~~~~
-
Test inventory util functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py
index 3c78368d1..bb3d3260a 100644
--- a/tests/test_util_logging.py
+++ b/tests/test_util_logging.py
@@ -1,7 +1,4 @@
"""
- test_util_logging
- ~~~~~~~~~~~~~~~~~
-
Test logging util.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_matching.py b/tests/test_util_matching.py
index 651546c92..91d284b23 100644
--- a/tests/test_util_matching.py
+++ b/tests/test_util_matching.py
@@ -1,7 +1,4 @@
"""
- test_util_matching
- ~~~~~~~~~~~~~~~~~~
-
Tests sphinx.util.matching functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_nodes.py b/tests/test_util_nodes.py
index fe0a278e6..a682dc295 100644
--- a/tests/test_util_nodes.py
+++ b/tests/test_util_nodes.py
@@ -1,7 +1,4 @@
"""
- test_util_nodes
- ~~~~~~~~~~~~~~~
-
Tests uti.nodes functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_rst.py b/tests/test_util_rst.py
index da3dba707..4f76f584a 100644
--- a/tests/test_util_rst.py
+++ b/tests/test_util_rst.py
@@ -1,7 +1,4 @@
"""
- test_util_rst
- ~~~~~~~~~~~~~~~
-
Tests sphinx.util.rst functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_template.py b/tests/test_util_template.py
index 36f1dac35..b752a4c34 100644
--- a/tests/test_util_template.py
+++ b/tests/test_util_template.py
@@ -1,7 +1,4 @@
"""
- test_util_template
- ~~~~~~~~~~~~~~~~~~
-
Tests sphinx.util.template functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_util_typing.py b/tests/test_util_typing.py
index 7d81fee5d..ca3611a44 100644
--- a/tests/test_util_typing.py
+++ b/tests/test_util_typing.py
@@ -1,7 +1,4 @@
"""
- test_util_typing
- ~~~~~~~~~~~~~~~~
-
Tests util.typing functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_versioning.py b/tests/test_versioning.py
index 4de8331aa..f615eb2cc 100644
--- a/tests/test_versioning.py
+++ b/tests/test_versioning.py
@@ -1,7 +1,4 @@
"""
- test_versioning
- ~~~~~~~~~~~~~~~
-
Test the versioning implementation.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/tests/test_writer_latex.py b/tests/test_writer_latex.py
index ccb578f3e..31d27d591 100644
--- a/tests/test_writer_latex.py
+++ b/tests/test_writer_latex.py
@@ -1,7 +1,4 @@
"""
- test_writer_latex
- ~~~~~~~~~~~~~~~~
-
Test the LaTeX writer
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
diff --git a/utils/checks.py b/utils/checks.py
index 093817409..6798fde01 100644
--- a/utils/checks.py
+++ b/utils/checks.py
@@ -1,7 +1,4 @@
"""
- utils.checks
- ~~~~~~~~~~~~
-
Custom, Sphinx-only flake8 plugins.
:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
diff --git a/utils/doclinter.py b/utils/doclinter.py
index b4b27748a..ed61b9c97 100644
--- a/utils/doclinter.py
+++ b/utils/doclinter.py
@@ -1,7 +1,4 @@
"""
- utils.doclinter
- ~~~~~~~~~~~~~~~
-
A linter for Sphinx docs
:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
diff --git a/utils/jssplitter_generator.py b/utils/jssplitter_generator.py
index 7806d64d2..0e95cfe56 100644
--- a/utils/jssplitter_generator.py
+++ b/utils/jssplitter_generator.py
@@ -113,9 +113,6 @@ console.log(' ... ok\\n')
python_src = '''\
"""
- sphinx.search.jssplitter
- ~~~~~~~~~~~~~~~~~~~~~~~~
-
Provides Python compatible word splitter to JavaScript
DO NOT EDIT. This is generated by utils/jssplitter_generator.py