Remove module titles in docstrings

This commit is contained in:
Adam Turner 2022-02-19 22:44:45 +00:00
parent b8789b4cb6
commit 6b8bccec59
280 changed files with 0 additions and 840 deletions

View File

@ -1,7 +1,4 @@
""" """
Sphinx
~~~~~~
The Sphinx documentation toolchain. The Sphinx documentation toolchain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.__main__
~~~~~~~~~~~~~~~
The Sphinx documentation toolchain. The Sphinx documentation toolchain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.addnodes
~~~~~~~~~~~~~~~
Additional docutils nodes. Additional docutils nodes.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

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

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders
~~~~~~~~~~~~~~~
Builder superclass for all builders. Builder superclass for all builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders._epub_base
~~~~~~~~~~~~~~~~~~~~~~~~~~
Base class of epub2/epub3 builders. Base class of epub2/epub3 builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.changes
~~~~~~~~~~~~~~~~~~~~~~~
Changelog builder. Changelog builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.dirhtml
~~~~~~~~~~~~~~~~~~~~~~~
Directory HTML builders. Directory HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.dummy
~~~~~~~~~~~~~~~~~~~~~
Do syntax checks, but no writing. Do syntax checks, but no writing.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.epub3
~~~~~~~~~~~~~~~~~~~~~
Build epub3 files. Build epub3 files.
Originally derived from epub.py. Originally derived from epub.py.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.gettext
~~~~~~~~~~~~~~~~~~~~~~~
The MessageCatalogBuilder class. The MessageCatalogBuilder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.html
~~~~~~~~~~~~~~~~~~~~
Several HTML builders. Several HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.html.transforms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Transforms for HTML builder. Transforms for HTML builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.latex
~~~~~~~~~~~~~~~~~~~~~
LaTeX builder. LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.latex.constants
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
consntants for LaTeX builder. consntants for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.latex.nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Additional nodes for LaTeX writer. Additional nodes for LaTeX writer.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.latex.theming
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Theming support for LaTeX builder. Theming support for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.latex.transforms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Transforms for LaTeX builder. Transforms for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.latex.util
~~~~~~~~~~~~~~~~~~~~~~~~~~
Utilities for LaTeX builder. Utilities for LaTeX builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.linkcheck
~~~~~~~~~~~~~~~~~~~~~~~~~
The CheckExternalLinksBuilder class. The CheckExternalLinksBuilder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.manpage
~~~~~~~~~~~~~~~~~~~~~~~
Manual pages builder. Manual pages builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.singlehtml
~~~~~~~~~~~~~~~~~~~~~~~~~~
Single HTML builders. Single HTML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.texinfo
~~~~~~~~~~~~~~~~~~~~~~~
Texinfo builder. Texinfo builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.text
~~~~~~~~~~~~~~~~~~~~
Plain-text Sphinx builder. Plain-text Sphinx builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.builders.xml
~~~~~~~~~~~~~~~~~~~
Docutils-native XML and pseudo-XML builders. Docutils-native XML and pseudo-XML builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.cmd
~~~~~~~~~~
Modules for command line executables. Modules for command line executables.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.cmd.build
~~~~~~~~~~~~~~~~
Build documentation from a provided source. Build documentation from a provided source.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.cmd.make_mode
~~~~~~~~~~~~~~~~~~~~
sphinx-build -M command-line handling. sphinx-build -M command-line handling.
This replaces the old, platform-dependent and once-generated content This replaces the old, platform-dependent and once-generated content

View File

@ -1,7 +1,4 @@
""" """
sphinx.cmd.quickstart
~~~~~~~~~~~~~~~~~~~~~
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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.config
~~~~~~~~~~~~~
Build configuration file handling. Build configuration file handling.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.deprecation
~~~~~~~~~~~~~~~~~~
Sphinx deprecation classes and utilities. Sphinx deprecation classes and utilities.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.directives
~~~~~~~~~~~~~~~~~
Handlers for additional ReST directives. Handlers for additional ReST directives.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.directives.code
~~~~~~~~~~~~~~~~~~~~~~
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details. :license: BSD, see LICENSE for details.
""" """

View File

@ -1,7 +1,4 @@
""" """
sphinx.directives.other
~~~~~~~~~~~~~~~~~~~~~~~
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details. :license: BSD, see LICENSE for details.
""" """

View File

@ -1,7 +1,4 @@
""" """
sphinx.directives.patches
~~~~~~~~~~~~~~~~~~~~~~~~~
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details. :license: BSD, see LICENSE for details.
""" """

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains
~~~~~~~~~~~~~~
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. and roles describing e.g. constructs of one programming language.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.c
~~~~~~~~~~~~~~~~
The C language domain. The C language domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.changeset
~~~~~~~~~~~~~~~~~~~~~~~~
The changeset domain. The changeset domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.citation
~~~~~~~~~~~~~~~~~~~~~~~
The citation domain. The citation domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.cpp
~~~~~~~~~~~~~~~~~~
The C++ language domain. The C++ language domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.index
~~~~~~~~~~~~~~~~~~~~
The index domain. The index domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.javascript
~~~~~~~~~~~~~~~~~~~~~~~~~
The JavaScript domain. The JavaScript domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.math
~~~~~~~~~~~~~~~~~~~
The math domain. The math domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.python
~~~~~~~~~~~~~~~~~~~~~
The Python domain. The Python domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.rst
~~~~~~~~~~~~~~~~~~
The reStructuredText domain. The reStructuredText domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.domains.std
~~~~~~~~~~~~~~~~~~
The standard domain. The standard domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment
~~~~~~~~~~~~~~~~~~
Global creation environment. Global creation environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.adapters
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sphinx environment adapters Sphinx environment adapters
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.adapters.asset
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Assets adapter for sphinx.environment. Assets adapter for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.adapters.indexentries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Index entries adapters for sphinx.environment. Index entries adapters for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.adapters.toctree
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Toctree adapter for sphinx.environment. Toctree adapter for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.collectors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The data collector components for sphinx.environment. The data collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.collectors.asset
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The image collector for sphinx.environment. The image collector for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.collectors.dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The dependencies collector components for sphinx.environment. The dependencies collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.collectors.metadata
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The metadata collector components for sphinx.environment. The metadata collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.collectors.title
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The title collector components for sphinx.environment. The title collector components for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.environment.collectors.toctree
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Toctree collector for sphinx.environment. Toctree collector for sphinx.environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.errors
~~~~~~~~~~~~~
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). circular import problems).

View File

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

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext
~~~~~~~~~~
Contains Sphinx features not activated by default. Contains Sphinx features not activated by default.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.apidoc
~~~~~~~~~~~~~~~~~
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 ReST files appropriately to create code documentation with Sphinx. It also
creates a modules index (named modules.<suffix>). creates a modules index (named modules.<suffix>).

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autodoc
~~~~~~~~~~~~~~~~~~
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 the doctree, thus avoiding duplication between docstrings and documentation
for those who like elaborate docstrings. for those who like elaborate docstrings.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autodoc.deprecated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The deprecated Documenters for autodoc. The deprecated Documenters for autodoc.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

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

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autodoc.importer
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Importer utilities for autodoc Importer utilities for autodoc
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autodoc.mock
~~~~~~~~~~~~~~~~~~~~~~~
mock for autodoc mock for autodoc
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autodoc.preserve_defaults
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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. and keep them not evaluated for readability.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autodoc.type_comment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autodoc.typehints
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Generating content for autodoc using typehints Generating content for autodoc using typehints
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autosectionlabel
~~~~~~~~~~~~~~~~~~~~~~~~~~~
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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autosummary
~~~~~~~~~~~~~~~~~~~~~~
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 used to generate function/method/attribute/etc. summary lists, similar
to those output eg. by Epydoc and other API doc generation tools. to those output eg. by Epydoc and other API doc generation tools.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.autosummary.generate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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. items referred to in autosummary:: directives.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.coverage
~~~~~~~~~~~~~~~~~~~
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. Dzolonga for the Google Highly Open Participation contest.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.doctest
~~~~~~~~~~~~~~~~~~
Mimic doctest by automatically executing code snippets and checking Mimic doctest by automatically executing code snippets and checking
their results. their results.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.duration
~~~~~~~~~~~~~~~~~~~
Measure durations of Sphinx processing. Measure durations of Sphinx processing.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.extlinks
~~~~~~~~~~~~~~~~~~~
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. files.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.githubpages
~~~~~~~~~~~~~~~~~~~~~~
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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.graphviz
~~~~~~~~~~~~~~~~~~~
Allow graphviz-formatted graphs to be included in Sphinx-generated Allow graphviz-formatted graphs to be included in Sphinx-generated
documents inline. documents inline.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.ifconfig
~~~~~~~~~~~~~~~~~~~
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. that is included depending on configuration variables.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.imgconverter
~~~~~~~~~~~~~~~~~~~~~~~
Image converter extension for Sphinx Image converter extension for Sphinx
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.imgmath
~~~~~~~~~~~~~~~~~~
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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
r""" r"""
sphinx.ext.inheritance_diagram
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Defines a docutils directive for inserting inheritance diagrams. Defines a docutils directive for inserting inheritance diagrams.
Provide the directive with one or more classes or modules (separated Provide the directive with one or more classes or modules (separated

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.intersphinx
~~~~~~~~~~~~~~~~~~~~~~
Insert links to objects documented in remote Sphinx documentation. Insert links to objects documented in remote Sphinx documentation.
This works as follows: This works as follows:

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.linkcode
~~~~~~~~~~~~~~~~~~~
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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.mathjax
~~~~~~~~~~~~~~~~~~
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 Sphinx's HTML writer -- requires the MathJax JavaScript library on your
webserver/computer. webserver/computer.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.napoleon
~~~~~~~~~~~~~~~~~~~
Support for NumPy and Google style docstrings. Support for NumPy and Google style docstrings.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.napoleon.docstring
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Classes for docstring parsing and formatting. Classes for docstring parsing and formatting.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.napoleon.iterators
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A collection of helpful iterators. A collection of helpful iterators.

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.todo
~~~~~~~~~~~~~~~
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 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 all todos of your project and lists them along with a backlink to the

View File

@ -1,7 +1,4 @@
""" """
sphinx.ext.viewcode
~~~~~~~~~~~~~~~~~~~
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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.extension
~~~~~~~~~~~~~~~~
Utilities for Sphinx extensions. Utilities for Sphinx extensions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.highlighting
~~~~~~~~~~~~~~~~~~~
Highlight code blocks using Pygments. Highlight code blocks using Pygments.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.io
~~~~~~~~~
Input/Output files Input/Output files
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.jinja2glue
~~~~~~~~~~~~~~~~~
Glue code for the jinja2 templating engine. Glue code for the jinja2 templating engine.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.locale
~~~~~~~~~~~~~
Locale utilities. Locale utilities.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.parsers
~~~~~~~~~~~~~~
A Base class for additional parsers. A Base class for additional parsers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.project
~~~~~~~~~~~~~~
Utility function and classes for Sphinx projects. Utility function and classes for Sphinx projects.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.pycode
~~~~~~~~~~~~~
Utilities parsing and analyzing Python code. Utilities parsing and analyzing Python code.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.pycode.ast
~~~~~~~~~~~~~~~~~
Helpers for AST (Abstract Syntax Tree). Helpers for AST (Abstract Syntax Tree).
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

View File

@ -1,7 +1,4 @@
""" """
sphinx.pycode.parser
~~~~~~~~~~~~~~~~~~~~
Utilities parsing and analyzing Python code. Utilities parsing and analyzing Python code.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.

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