Fix module docstring first line

This commit is contained in:
Adam Turner 2022-02-20 00:06:24 +00:00
parent 6b8bccec59
commit 4f5a3269a6
270 changed files with 270 additions and 540 deletions

View File

@ -1,5 +1,4 @@
"""
The Sphinx documentation toolchain.
"""The Sphinx documentation toolchain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The Sphinx documentation toolchain.
"""The Sphinx documentation toolchain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Additional docutils nodes.
"""Additional docutils nodes.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Sphinx application class and extensibility interface.
"""Sphinx application class and extensibility interface.
Gracefully adapted from the TextPress system by Armin.

View File

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

View File

@ -1,5 +1,4 @@
"""
Base class of epub2/epub3 builders.
"""Base class of epub2/epub3 builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Changelog builder.
"""Changelog builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Directory HTML builders.
"""Directory HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Do syntax checks, but no writing.
"""Do syntax checks, but no writing.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Build epub3 files.
"""Build epub3 files.
Originally derived from epub.py.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,5 +1,4 @@
"""
The MessageCatalogBuilder class.
"""The MessageCatalogBuilder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Several HTML builders.
"""Several HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Transforms for HTML builder.
"""Transforms for HTML builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
LaTeX builder.
"""LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
consntants for LaTeX builder.
"""consntants for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Additional nodes for LaTeX writer.
"""Additional nodes for LaTeX writer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Theming support for LaTeX builder.
"""Theming support for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Transforms for LaTeX builder.
"""Transforms for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Utilities for LaTeX builder.
"""Utilities for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The CheckExternalLinksBuilder class.
"""The CheckExternalLinksBuilder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Manual pages builder.
"""Manual pages builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Single HTML builders.
"""Single HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Texinfo builder.
"""Texinfo builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Plain-text Sphinx builder.
"""Plain-text Sphinx builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Docutils-native XML and pseudo-XML builders.
"""Docutils-native XML and pseudo-XML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

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

View File

@ -1,5 +1,4 @@
"""
Build documentation from a provided source.
"""Build documentation from a provided source.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
sphinx-build -M command-line handling.
"""sphinx-build -M command-line handling.
This replaces the old, platform-dependent and once-generated content
of Makefile / make.bat.

View File

@ -1,5 +1,4 @@
"""
Quickly setup documentation source to work with Sphinx.
"""Quickly setup documentation source to work with Sphinx.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Build configuration file handling.
"""Build configuration file handling.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

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

View File

@ -1,5 +1,4 @@
"""
Handlers for additional ReST directives.
"""Handlers for additional ReST directives.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Support for domains, which are groupings of description directives
"""Support for domains, which are groupings of description directives
and roles describing e.g. constructs of one programming language.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,5 +1,4 @@
"""
The C language domain.
"""The C language domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The changeset domain.
"""The changeset domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The citation domain.
"""The citation domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The C++ language domain.
"""The C++ language domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The index domain.
"""The index domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The JavaScript domain.
"""The JavaScript domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The math domain.
"""The math domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The Python domain.
"""The Python domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The reStructuredText domain.
"""The reStructuredText domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The standard domain.
"""The standard domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Global creation environment.
"""Global creation environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

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

View File

@ -1,5 +1,4 @@
"""
Assets adapter for sphinx.environment.
"""Assets adapter for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

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

View File

@ -1,5 +1,4 @@
"""
Toctree adapter for sphinx.environment.
"""Toctree adapter for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The data collector components for sphinx.environment.
"""The data collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The image collector for sphinx.environment.
"""The image collector for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The dependencies collector components for sphinx.environment.
"""The dependencies collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The metadata collector components for sphinx.environment.
"""The metadata collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
The title collector components for sphinx.environment.
"""The title collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Toctree collector for sphinx.environment.
"""Toctree collector for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Contains SphinxError and a few subclasses (in an extra module to avoid
"""Contains SphinxError and a few subclasses (in an extra module to avoid
circular import problems).
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,5 +1,4 @@
"""
Sphinx core events.
"""Sphinx core events.
Gracefully adapted from the TextPress system by Armin.

View File

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

View File

@ -1,5 +1,4 @@
"""
Parses a directory tree looking for Python modules and packages and creates
"""Parses a directory tree looking for Python modules and packages and creates
ReST files appropriately to create code documentation with Sphinx. It also
creates a modules index (named modules.<suffix>).

View File

@ -1,5 +1,4 @@
"""
Automatically insert docstrings for functions, classes or whole modules into
"""Automatically insert docstrings for functions, classes or whole modules into
the doctree, thus avoiding duplication between docstrings and documentation
for those who like elaborate docstrings.

View File

@ -1,5 +1,4 @@
"""
The deprecated Documenters for autodoc.
"""The deprecated Documenters for autodoc.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Importer utilities for autodoc
"""Importer utilities for autodoc
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
mock for autodoc
"""mock for autodoc
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Preserve the default argument values of function signatures in source code
"""Preserve the default argument values of function signatures in source code
and keep them not evaluated for readability.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,5 +1,4 @@
"""
Update annotations info of living objects using type_comments.
"""Update annotations info of living objects using type_comments.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Generating content for autodoc using typehints
"""Generating content for autodoc using typehints
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Allow reference sections by :ref: role using its title.
"""Allow reference sections by :ref: role using its title.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Sphinx extension that adds an autosummary:: directive, which can be
"""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.

View File

@ -1,5 +1,4 @@
"""
Usable as a library or script to generate automatic RST source files for
"""Usable as a library or script to generate automatic RST source files for
items referred to in autosummary:: directives.
Each generated RST file contains a single auto*:: directive which

View File

@ -1,5 +1,4 @@
"""
Check Python modules and C API for coverage. Mostly written by Josip
"""Check Python modules and C API for coverage. Mostly written by Josip
Dzolonga for the Google Highly Open Participation contest.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,5 +1,4 @@
"""
Mimic doctest by automatically executing code snippets and checking
"""Mimic doctest by automatically executing code snippets and checking
their results.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,5 +1,4 @@
"""
Measure durations of Sphinx processing.
"""Measure durations of Sphinx processing.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Extension to save typing and prevent hard-coding of base URLs in the reST
"""Extension to save typing and prevent hard-coding of base URLs in the reST
files.
This adds a new config value called ``extlinks`` that is created like this::

View File

@ -1,5 +1,4 @@
"""
To publish HTML docs at GitHub Pages, create .nojekyll file.
"""To publish HTML docs at GitHub Pages, create .nojekyll file.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Allow graphviz-formatted graphs to be included in Sphinx-generated
"""Allow graphviz-formatted graphs to be included in Sphinx-generated
documents inline.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,5 +1,4 @@
"""
Provides the ``ifconfig`` directive that allows to write documentation
"""Provides the ``ifconfig`` directive that allows to write documentation
that is included depending on configuration variables.
Usage::

View File

@ -1,5 +1,4 @@
"""
Image converter extension for Sphinx
"""Image converter extension for Sphinx
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Render math in HTML via dvipng or dvisvgm.
"""Render math in HTML via dvipng or dvisvgm.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
r"""
Defines a docutils directive for inserting inheritance diagrams.
r"""Defines a docutils directive for inserting inheritance diagrams.
Provide the directive with one or more classes or modules (separated
by whitespace). For modules, all of the classes in that module will

View File

@ -1,5 +1,4 @@
"""
Insert links to objects documented in remote Sphinx documentation.
"""Insert links to objects documented in remote Sphinx documentation.
This works as follows:

View File

@ -1,5 +1,4 @@
"""
Add external links to module code in Python object descriptions.
"""Add external links to module code in Python object descriptions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Allow `MathJax <https://www.mathjax.org/>`_ to be used to display math in
"""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.

View File

@ -1,5 +1,4 @@
"""
Support for NumPy and Google style docstrings.
"""Support for NumPy and Google style docstrings.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Allow todos to be inserted into your documentation. Inclusion of todos can
"""Allow todos to be inserted into your documentation. Inclusion of todos can
be switched of by a configuration variable. The todolist directive collects
all todos of your project and lists them along with a backlink to the
original location.

View File

@ -1,5 +1,4 @@
"""
Add links to module code in Python object descriptions.
"""Add links to module code in Python object descriptions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Utilities for Sphinx extensions.
"""Utilities for Sphinx extensions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Highlight code blocks using Pygments.
"""Highlight code blocks using Pygments.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Input/Output files
"""Input/Output files
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Glue code for the jinja2 templating engine.
"""Glue code for the jinja2 templating engine.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Locale utilities.
"""Locale utilities.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
A Base class for additional parsers.
"""A Base class for additional parsers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Utility function and classes for Sphinx projects.
"""Utility function and classes for Sphinx projects.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Utilities parsing and analyzing Python code.
"""Utilities parsing and analyzing Python code.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Helpers for AST (Abstract Syntax Tree).
"""Helpers for AST (Abstract Syntax Tree).
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Utilities parsing and analyzing Python code.
"""Utilities parsing and analyzing Python code.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Sphinx theme specific highlighting styles.
"""Sphinx theme specific highlighting styles.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Sphinx component registry.
"""Sphinx component registry.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Handlers for additional ReST roles.
"""Handlers for additional ReST roles.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Create a full-text search index for offline search.
"""Create a full-text search index for offline search.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
Danish search language: includes the JS Danish stemmer.
"""Danish search language: includes the JS Danish stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

View File

@ -1,5 +1,4 @@
"""
German search language: includes the JS German stemmer.
"""German search language: includes the JS German stemmer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.

Some files were not shown because too many files have changed in this diff Show More