diff options
author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-02-20 06:05:56 +0300 |
---|---|---|
committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-02-20 06:13:45 +0300 |
commit | 5775912455c25ee82734e1ff319a32f55946d79b (patch) | |
tree | e75fe3b61f6d92afb29fd38478e03d96179af015 /sphinx | |
parent | 6bb7b891a16fbcd5fad1f88fb472505549b9c084 (diff) |
Collapse single line docstrings
Diffstat (limited to 'sphinx')
141 files changed, 141 insertions, 282 deletions
diff --git a/sphinx/__init__.py b/sphinx/__init__.py index a77d4b147..6a2bcb25b 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -1,5 +1,4 @@ -"""The Sphinx documentation toolchain. -""" +"""The Sphinx documentation toolchain.""" # Keep this file executable as-is in Python 3! # (Otherwise getting the version out of it from setup.py is impossible.) diff --git a/sphinx/__main__.py b/sphinx/__main__.py index 5caff6510..887bb6ae1 100644 --- a/sphinx/__main__.py +++ b/sphinx/__main__.py @@ -1,5 +1,4 @@ -"""The Sphinx documentation toolchain. -""" +"""The Sphinx documentation toolchain.""" import sys diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index 88545c820..bf74bd1aa 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -1,5 +1,4 @@ -"""Additional docutils nodes. -""" +"""Additional docutils nodes.""" from typing import TYPE_CHECKING, Any, Dict, List, Sequence diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index e99212dca..e1817c445 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -1,5 +1,4 @@ -"""Builder superclass for all builders. -""" +"""Builder superclass for all builders.""" import pickle import time diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index 8dec8546f..26efdc1fb 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -1,5 +1,4 @@ -"""Base class of epub2/epub3 builders. -""" +"""Base class of epub2/epub3 builders.""" import html import os diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index 5230f1a24..3a1f5bd65 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -1,5 +1,4 @@ -"""Changelog builder. -""" +"""Changelog builder.""" import html from os import path diff --git a/sphinx/builders/dirhtml.py b/sphinx/builders/dirhtml.py index 3397b9aaf..bf8af15bb 100644 --- a/sphinx/builders/dirhtml.py +++ b/sphinx/builders/dirhtml.py @@ -1,5 +1,4 @@ -"""Directory HTML builders. -""" +"""Directory HTML builders.""" from os import path from typing import Any, Dict diff --git a/sphinx/builders/dummy.py b/sphinx/builders/dummy.py index ae8bfa32a..f4f1356f6 100644 --- a/sphinx/builders/dummy.py +++ b/sphinx/builders/dummy.py @@ -1,5 +1,4 @@ -"""Do syntax checks, but no writing. -""" +"""Do syntax checks, but no writing.""" from typing import Any, Dict, Set diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index a8e9d25fd..e8bc547b7 100644 --- a/sphinx/builders/gettext.py +++ b/sphinx/builders/gettext.py @@ -1,5 +1,4 @@ -"""The MessageCatalogBuilder class. -""" +"""The MessageCatalogBuilder class.""" from codecs import open from collections import OrderedDict, defaultdict diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py index 006f06505..bbd3b91e0 100644 --- a/sphinx/builders/html/__init__.py +++ b/sphinx/builders/html/__init__.py @@ -1,5 +1,4 @@ -"""Several HTML builders. -""" +"""Several HTML builders.""" import html import os diff --git a/sphinx/builders/html/transforms.py b/sphinx/builders/html/transforms.py index 74dd3c23d..ea596cb4b 100644 --- a/sphinx/builders/html/transforms.py +++ b/sphinx/builders/html/transforms.py @@ -1,5 +1,4 @@ -"""Transforms for HTML builder. -""" +"""Transforms for HTML builder.""" import re from typing import Any, Dict, List diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index 4ee9279a2..fb33007f1 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -1,5 +1,4 @@ -"""LaTeX builder. -""" +"""LaTeX builder.""" import os import warnings diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py index d208f9a60..ace608644 100644 --- a/sphinx/builders/latex/constants.py +++ b/sphinx/builders/latex/constants.py @@ -1,5 +1,4 @@ -"""consntants for LaTeX builder. -""" +"""consntants for LaTeX builder.""" from typing import Any, Dict diff --git a/sphinx/builders/latex/nodes.py b/sphinx/builders/latex/nodes.py index adf0a0f63..2c008b9a7 100644 --- a/sphinx/builders/latex/nodes.py +++ b/sphinx/builders/latex/nodes.py @@ -1,5 +1,4 @@ -"""Additional nodes for LaTeX writer. -""" +"""Additional nodes for LaTeX writer.""" from docutils import nodes diff --git a/sphinx/builders/latex/theming.py b/sphinx/builders/latex/theming.py index 1f09ebd07..69f849381 100644 --- a/sphinx/builders/latex/theming.py +++ b/sphinx/builders/latex/theming.py @@ -1,5 +1,4 @@ -"""Theming support for LaTeX builder. -""" +"""Theming support for LaTeX builder.""" import configparser from os import path diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py index a4d6cc8e0..5e478f5c4 100644 --- a/sphinx/builders/latex/transforms.py +++ b/sphinx/builders/latex/transforms.py @@ -1,5 +1,4 @@ -"""Transforms for LaTeX builder. -""" +"""Transforms for LaTeX builder.""" from typing import Any, Dict, List, Set, Tuple, cast diff --git a/sphinx/builders/latex/util.py b/sphinx/builders/latex/util.py index 5419f2c1a..6883829c5 100644 --- a/sphinx/builders/latex/util.py +++ b/sphinx/builders/latex/util.py @@ -1,5 +1,4 @@ -"""Utilities for LaTeX builder. -""" +"""Utilities for LaTeX builder.""" from typing import Optional diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index d9d0cb3d7..a94572484 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -1,5 +1,4 @@ -"""The CheckExternalLinksBuilder class. -""" +"""The CheckExternalLinksBuilder class.""" import json import re diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index 04c154dce..43637b65a 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -1,5 +1,4 @@ -"""Manual pages builder. -""" +"""Manual pages builder.""" from os import path from typing import Any, Dict, List, Set, Tuple, Union diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py index 1a9b6a7eb..d177474a6 100644 --- a/sphinx/builders/singlehtml.py +++ b/sphinx/builders/singlehtml.py @@ -1,5 +1,4 @@ -"""Single HTML builders. -""" +"""Single HTML builders.""" from os import path from typing import Any, Dict, List, Tuple, Union diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index 6b42c4635..24a19b0df 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -1,5 +1,4 @@ -"""Texinfo builder. -""" +"""Texinfo builder.""" import os from os import path diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index 8da91d462..bcd479864 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -1,5 +1,4 @@ -"""Plain-text Sphinx builder. -""" +"""Plain-text Sphinx builder.""" from os import path from typing import Any, Dict, Iterator, Set, Tuple diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py index e16bbe36a..0f45b912c 100644 --- a/sphinx/builders/xml.py +++ b/sphinx/builders/xml.py @@ -1,5 +1,4 @@ -"""Docutils-native XML and pseudo-XML builders. -""" +"""Docutils-native XML and pseudo-XML builders.""" from os import path from typing import Any, Dict, Iterator, Set, Type, Union diff --git a/sphinx/cmd/__init__.py b/sphinx/cmd/__init__.py index 7b9ded4d3..4d277c5ea 100644 --- a/sphinx/cmd/__init__.py +++ b/sphinx/cmd/__init__.py @@ -1,2 +1 @@ -"""Modules for command line executables. -""" +"""Modules for command line executables.""" diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index 2df308b9e..00a06762a 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -1,5 +1,4 @@ -"""Build documentation from a provided source. -""" +"""Build documentation from a provided source.""" import argparse import bdb diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index 6accb75d0..e8b446d40 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -1,5 +1,4 @@ -"""Quickly setup documentation source to work with Sphinx. -""" +"""Quickly setup documentation source to work with Sphinx.""" import argparse import locale diff --git a/sphinx/config.py b/sphinx/config.py index ecbf7fa43..50de07b72 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -1,5 +1,4 @@ -"""Build configuration file handling. -""" +"""Build configuration file handling.""" import re import traceback diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py index f08465d40..5661c535d 100644 --- a/sphinx/deprecation.py +++ b/sphinx/deprecation.py @@ -1,5 +1,4 @@ -"""Sphinx deprecation classes and utilities. -""" +"""Sphinx deprecation classes and utilities.""" import sys import warnings diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index a74717377..0e5cc0c60 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -1,5 +1,4 @@ -"""Handlers for additional ReST directives. -""" +"""Handlers for additional ReST directives.""" import re from typing import TYPE_CHECKING, Any, Dict, Generic, List, Tuple, TypeVar, cast diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index ade5c4a6f..176a1def1 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -1,5 +1,4 @@ -"""The C language domain. -""" +"""The C language domain.""" import re from typing import (Any, Callable, Dict, Generator, Iterator, List, Optional, Tuple, TypeVar, diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index e9891d480..31fa44020 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -1,5 +1,4 @@ -"""The changeset domain. -""" +"""The changeset domain.""" from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, cast diff --git a/sphinx/domains/citation.py b/sphinx/domains/citation.py index e6043cc32..39e63b659 100644 --- a/sphinx/domains/citation.py +++ b/sphinx/domains/citation.py @@ -1,5 +1,4 @@ -"""The citation domain. -""" +"""The citation domain.""" from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, cast diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index d504dc5bf..e82a8f4d5 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1,5 +1,4 @@ -"""The C++ language domain. -""" +"""The C++ language domain.""" import re from typing import (Any, Callable, Dict, Generator, Iterator, List, Optional, Tuple, TypeVar, diff --git a/sphinx/domains/index.py b/sphinx/domains/index.py index 81ffe36f5..8c630c8f5 100644 --- a/sphinx/domains/index.py +++ b/sphinx/domains/index.py @@ -1,5 +1,4 @@ -"""The index domain. -""" +"""The index domain.""" from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Tuple diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 79dc3674f..ab16cdd85 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -1,5 +1,4 @@ -"""The JavaScript domain. -""" +"""The JavaScript domain.""" from typing import Any, Dict, Iterator, List, Optional, Tuple, cast diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py index ffece1f5d..6df7d30cb 100644 --- a/sphinx/domains/math.py +++ b/sphinx/domains/math.py @@ -1,5 +1,4 @@ -"""The math domain. -""" +"""The math domain.""" from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index 28e61ff46..f55d76ba0 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -1,5 +1,4 @@ -"""The Python domain. -""" +"""The Python domain.""" import builtins import inspect diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py index 9d5d82de9..f861ecad1 100644 --- a/sphinx/domains/rst.py +++ b/sphinx/domains/rst.py @@ -1,5 +1,4 @@ -"""The reStructuredText domain. -""" +"""The reStructuredText domain.""" import re from typing import Any, Dict, Iterator, List, Optional, Tuple, cast diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index 50c872511..11a3260b7 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -1,5 +1,4 @@ -"""The standard domain. -""" +"""The standard domain.""" import re import warnings diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index ef7bcae15..b5b135241 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -1,5 +1,4 @@ -"""Global creation environment. -""" +"""Global creation environment.""" import os import pickle diff --git a/sphinx/environment/adapters/__init__.py b/sphinx/environment/adapters/__init__.py index 03b8bde74..1566aecba 100644 --- a/sphinx/environment/adapters/__init__.py +++ b/sphinx/environment/adapters/__init__.py @@ -1,2 +1 @@ -"""Sphinx environment adapters -""" +"""Sphinx environment adapters""" diff --git a/sphinx/environment/adapters/asset.py b/sphinx/environment/adapters/asset.py index 29188b484..57fdc91f1 100644 --- a/sphinx/environment/adapters/asset.py +++ b/sphinx/environment/adapters/asset.py @@ -1,5 +1,4 @@ -"""Assets adapter for sphinx.environment. -""" +"""Assets adapter for sphinx.environment.""" from sphinx.environment import BuildEnvironment diff --git a/sphinx/environment/adapters/indexentries.py b/sphinx/environment/adapters/indexentries.py index 27a5f42b5..49881b76d 100644 --- a/sphinx/environment/adapters/indexentries.py +++ b/sphinx/environment/adapters/indexentries.py @@ -1,5 +1,4 @@ -"""Index entries adapters for sphinx.environment. -""" +"""Index entries adapters for sphinx.environment.""" import re import unicodedata diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index 72ce7e295..631060e75 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/sphinx/environment/adapters/toctree.py @@ -1,5 +1,4 @@ -"""Toctree adapter for sphinx.environment. -""" +"""Toctree adapter for sphinx.environment.""" from typing import TYPE_CHECKING, Any, Iterable, List, Optional, cast diff --git a/sphinx/environment/collectors/__init__.py b/sphinx/environment/collectors/__init__.py index 1da2c9807..6f12c1323 100644 --- a/sphinx/environment/collectors/__init__.py +++ b/sphinx/environment/collectors/__init__.py @@ -1,5 +1,4 @@ -"""The data collector components for sphinx.environment. -""" +"""The data collector components for sphinx.environment.""" from typing import TYPE_CHECKING, Dict, List, Optional, Set diff --git a/sphinx/environment/collectors/asset.py b/sphinx/environment/collectors/asset.py index 2cb78adf6..6bb922c66 100644 --- a/sphinx/environment/collectors/asset.py +++ b/sphinx/environment/collectors/asset.py @@ -1,5 +1,4 @@ -"""The image collector for sphinx.environment. -""" +"""The image collector for sphinx.environment.""" import os from glob import glob diff --git a/sphinx/environment/collectors/dependencies.py b/sphinx/environment/collectors/dependencies.py index 6052ede5c..87f7c29f2 100644 --- a/sphinx/environment/collectors/dependencies.py +++ b/sphinx/environment/collectors/dependencies.py @@ -1,5 +1,4 @@ -"""The dependencies collector components for sphinx.environment. -""" +"""The dependencies collector components for sphinx.environment.""" import os from os import path diff --git a/sphinx/environment/collectors/metadata.py b/sphinx/environment/collectors/metadata.py index 4075e8bc7..c70a5d408 100644 --- a/sphinx/environment/collectors/metadata.py +++ b/sphinx/environment/collectors/metadata.py @@ -1,5 +1,4 @@ -"""The metadata collector components for sphinx.environment. -""" +"""The metadata collector components for sphinx.environment.""" from typing import Any, Dict, List, Set, cast diff --git a/sphinx/environment/collectors/title.py b/sphinx/environment/collectors/title.py index 46e6e5937..10c5560fd 100644 --- a/sphinx/environment/collectors/title.py +++ b/sphinx/environment/collectors/title.py @@ -1,5 +1,4 @@ -"""The title collector components for sphinx.environment. -""" +"""The title collector components for sphinx.environment.""" from typing import Any, Dict, Set diff --git a/sphinx/environment/collectors/toctree.py b/sphinx/environment/collectors/toctree.py index 6656f3937..75c981f3c 100644 --- a/sphinx/environment/collectors/toctree.py +++ b/sphinx/environment/collectors/toctree.py @@ -1,5 +1,4 @@ -"""Toctree collector for sphinx.environment. -""" +"""Toctree collector for sphinx.environment.""" from typing import Any, Dict, List, Set, Tuple, Type, TypeVar, cast diff --git a/sphinx/errors.py b/sphinx/errors.py index c5f8ea2fe..a0263c613 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,5 +1,4 @@ -"""Contains SphinxError and a few subclasses. -""" +"""Contains SphinxError and a few subclasses.""" from typing import Any diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py index 635c4be59..16170d4cf 100644 --- a/sphinx/ext/__init__.py +++ b/sphinx/ext/__init__.py @@ -1,2 +1 @@ -"""Contains Sphinx features not activated by default. -""" +"""Contains Sphinx features not activated by default.""" diff --git a/sphinx/ext/autodoc/deprecated.py b/sphinx/ext/autodoc/deprecated.py index c20de236c..7eede8eeb 100644 --- a/sphinx/ext/autodoc/deprecated.py +++ b/sphinx/ext/autodoc/deprecated.py @@ -1,5 +1,4 @@ -"""The deprecated Documenters for autodoc. -""" +"""The deprecated Documenters for autodoc.""" import warnings from typing import Any diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py index 5d03c3f01..9d5902d2f 100644 --- a/sphinx/ext/autodoc/importer.py +++ b/sphinx/ext/autodoc/importer.py @@ -1,5 +1,4 @@ -"""Importer utilities for autodoc -""" +"""Importer utilities for autodoc""" import importlib import traceback diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py index ae49b30f0..f9e14a0cd 100644 --- a/sphinx/ext/autodoc/mock.py +++ b/sphinx/ext/autodoc/mock.py @@ -1,5 +1,4 @@ -"""mock for autodoc -""" +"""mock for autodoc""" import contextlib import os diff --git a/sphinx/ext/autodoc/type_comment.py b/sphinx/ext/autodoc/type_comment.py index 8578f282d..9881ae747 100644 --- a/sphinx/ext/autodoc/type_comment.py +++ b/sphinx/ext/autodoc/type_comment.py @@ -1,5 +1,4 @@ -"""Update annotations info of living objects using type_comments. -""" +"""Update annotations info of living objects using type_comments.""" from inspect import Parameter, Signature, getsource from typing import Any, Dict, List, cast diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py index c9099198c..2b5ceb4a6 100644 --- a/sphinx/ext/autodoc/typehints.py +++ b/sphinx/ext/autodoc/typehints.py @@ -1,5 +1,4 @@ -"""Generating content for autodoc using typehints -""" +"""Generating content for autodoc using typehints""" import re from collections import OrderedDict diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py index 315a4d24b..ff2f695ec 100644 --- a/sphinx/ext/autosectionlabel.py +++ b/sphinx/ext/autosectionlabel.py @@ -1,5 +1,4 @@ -"""Allow reference sections by :ref: role using its title. -""" +"""Allow reference sections by :ref: role using its title.""" from typing import Any, Dict, cast diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py index 9be5d4d01..94fd9077a 100644 --- a/sphinx/ext/duration.py +++ b/sphinx/ext/duration.py @@ -1,5 +1,4 @@ -"""Measure durations of Sphinx processing. -""" +"""Measure durations of Sphinx processing.""" from datetime import datetime, timedelta from itertools import islice diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py index 0f6f53cc3..e250fb2f2 100644 --- a/sphinx/ext/githubpages.py +++ b/sphinx/ext/githubpages.py @@ -1,5 +1,4 @@ -"""To publish HTML docs at GitHub Pages, create .nojekyll file. -""" +"""To publish HTML docs at GitHub Pages, create .nojekyll file.""" import os import urllib diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index 47782c06c..a40b6c46a 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -1,5 +1,4 @@ -"""Image converter extension for Sphinx -""" +"""Image converter extension for Sphinx""" import subprocess import sys diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index 29e69f45c..2c908daab 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -1,5 +1,4 @@ -"""Render math in HTML via dvipng or dvisvgm. -""" +"""Render math in HTML via dvipng or dvisvgm.""" import posixpath import re diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index 38320ea7e..ad7abd31b 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -1,5 +1,4 @@ -"""Add external links to module code in Python object descriptions. -""" +"""Add external links to module code in Python object descriptions.""" from typing import Any, Dict, Set diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index 273e3a2dd..d0dfaf825 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -1,5 +1,4 @@ -"""Support for NumPy and Google style docstrings. -""" +"""Support for NumPy and Google style docstrings.""" from typing import Any, Dict, List diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 4a96e9562..5aff7c67d 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -1,5 +1,4 @@ -"""Add links to module code in Python object descriptions. -""" +"""Add links to module code in Python object descriptions.""" import posixpath import traceback diff --git a/sphinx/extension.py b/sphinx/extension.py index e11d75f8f..356b4ab9d 100644 --- a/sphinx/extension.py +++ b/sphinx/extension.py @@ -1,5 +1,4 @@ -"""Utilities for Sphinx extensions. -""" +"""Utilities for Sphinx extensions.""" from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 52fe098dc..a7e5e4940 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -1,5 +1,4 @@ -"""Highlight code blocks using Pygments. -""" +"""Highlight code blocks using Pygments.""" from functools import partial from importlib import import_module diff --git a/sphinx/io.py b/sphinx/io.py index 3d4be299f..936631d51 100644 --- a/sphinx/io.py +++ b/sphinx/io.py @@ -1,5 +1,4 @@ -"""Input/Output files -""" +"""Input/Output files""" import codecs from typing import TYPE_CHECKING, Any, List, Type diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index a38338d24..a0d1f65ea 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -1,5 +1,4 @@ -"""Glue code for the jinja2 templating engine. -""" +"""Glue code for the jinja2 templating engine.""" from os import path from pprint import pformat diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py index 03f91b1f3..b9bdff0f9 100644 --- a/sphinx/locale/__init__.py +++ b/sphinx/locale/__init__.py @@ -1,5 +1,4 @@ -"""Locale utilities. -""" +"""Locale utilities.""" import gettext import locale diff --git a/sphinx/parsers.py b/sphinx/parsers.py index 2665d1265..b044f983b 100644 --- a/sphinx/parsers.py +++ b/sphinx/parsers.py @@ -1,5 +1,4 @@ -"""A Base class for additional parsers. -""" +"""A Base class for additional parsers.""" import warnings from typing import TYPE_CHECKING, Any, Dict, List, Type, Union diff --git a/sphinx/project.py b/sphinx/project.py index 63d5819fd..134055866 100644 --- a/sphinx/project.py +++ b/sphinx/project.py @@ -1,5 +1,4 @@ -"""Utility function and classes for Sphinx projects. -""" +"""Utility function and classes for Sphinx projects.""" import os from glob import glob diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index 96fba91a1..5f386d62f 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -1,5 +1,4 @@ -"""Utilities parsing and analyzing Python code. -""" +"""Utilities parsing and analyzing Python code.""" import re import tokenize diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py index 7f5e40d4d..755116475 100644 --- a/sphinx/pycode/ast.py +++ b/sphinx/pycode/ast.py @@ -1,5 +1,4 @@ -"""Helpers for AST (Abstract Syntax Tree). -""" +"""Helpers for AST (Abstract Syntax Tree).""" import sys from typing import Dict, List, Optional, Type, overload diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py index 303d7ae27..ff1135c25 100644 --- a/sphinx/pycode/parser.py +++ b/sphinx/pycode/parser.py @@ -1,5 +1,4 @@ -"""Utilities parsing and analyzing Python code. -""" +"""Utilities parsing and analyzing Python code.""" import inspect import itertools import re diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py index 2d5e23c67..ffc7f7f0b 100644 --- a/sphinx/pygments_styles.py +++ b/sphinx/pygments_styles.py @@ -1,5 +1,4 @@ -"""Sphinx theme specific highlighting styles. -""" +"""Sphinx theme specific highlighting styles.""" from pygments.style import Style from pygments.styles.friendly import FriendlyStyle diff --git a/sphinx/registry.py b/sphinx/registry.py index b51d07d3a..0f8010956 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -1,5 +1,4 @@ -"""Sphinx component registry. -""" +"""Sphinx component registry.""" import traceback import warnings diff --git a/sphinx/roles.py b/sphinx/roles.py index 73d7feb0e..5e467937b 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -1,5 +1,4 @@ -"""Handlers for additional ReST roles. -""" +"""Handlers for additional ReST roles.""" import re from typing import TYPE_CHECKING, Any, Dict, List, Tuple, Type diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index 00e209603..5fa35ae16 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -1,5 +1,4 @@ -"""Create a full-text search index for offline search. -""" +"""Create a full-text search index for offline search.""" import html import pickle import re diff --git a/sphinx/search/da.py b/sphinx/search/da.py index 5c3d138dd..42559ad93 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -1,5 +1,4 @@ -"""Danish search language: includes the JS Danish stemmer. -""" +"""Danish search language: includes the JS Danish stemmer.""" from typing import Dict diff --git a/sphinx/search/de.py b/sphinx/search/de.py index 8223f11f1..3896629de 100644 --- a/sphinx/search/de.py +++ b/sphinx/search/de.py @@ -1,5 +1,4 @@ -"""German search language: includes the JS German stemmer. -""" +"""German search language: includes the JS German stemmer.""" from typing import Dict diff --git a/sphinx/search/en.py b/sphinx/search/en.py index 2f2f157e8..53cd917dc 100644 --- a/sphinx/search/en.py +++ b/sphinx/search/en.py @@ -1,5 +1,4 @@ -"""English search language: includes the JS porter stemmer. -""" +"""English search language: includes the JS porter stemmer.""" from typing import Dict diff --git a/sphinx/search/es.py b/sphinx/search/es.py index 79e7e76d3..7aba54bfd 100644 --- a/sphinx/search/es.py +++ b/sphinx/search/es.py @@ -1,5 +1,4 @@ -"""Spanish search language: includes the JS Spanish stemmer. -""" +"""Spanish search language: includes the JS Spanish stemmer.""" from typing import Dict diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py index 9ca7f9d05..36f7e7747 100644 --- a/sphinx/search/fi.py +++ b/sphinx/search/fi.py @@ -1,5 +1,4 @@ -"""Finnish search language: includes the JS Finnish stemmer. -""" +"""Finnish search language: includes the JS Finnish stemmer.""" from typing import Dict diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py index ad1ac547a..a469bc922 100644 --- a/sphinx/search/fr.py +++ b/sphinx/search/fr.py @@ -1,5 +1,4 @@ -"""French search language: includes the JS French stemmer. -""" +"""French search language: includes the JS French stemmer.""" from typing import Dict diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py index 46e8eae09..23f7d85bb 100644 --- a/sphinx/search/hu.py +++ b/sphinx/search/hu.py @@ -1,5 +1,4 @@ -"""Hungarian search language: includes the JS Hungarian stemmer. -""" +"""Hungarian search language: includes the JS Hungarian stemmer.""" from typing import Dict diff --git a/sphinx/search/it.py b/sphinx/search/it.py index c42e0ae54..80b3b3a6d 100644 --- a/sphinx/search/it.py +++ b/sphinx/search/it.py @@ -1,5 +1,4 @@ -"""Italian search language: includes the JS Italian stemmer. -""" +"""Italian search language: includes the JS Italian stemmer.""" from typing import Dict diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index 5d18b702a..38520edc3 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -1,5 +1,4 @@ -"""Japanese search language: includes routine to split words. -""" +"""Japanese search language: includes routine to split words.""" # Python Version of TinySegmenter # (http://chasen.org/~taku/software/TinySegmenter/) diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py index abb958fb9..b5c549f66 100644 --- a/sphinx/search/nl.py +++ b/sphinx/search/nl.py @@ -1,5 +1,4 @@ -"""Dutch search language: includes the JS porter stemmer. -""" +"""Dutch search language: includes the JS porter stemmer.""" from typing import Dict diff --git a/sphinx/search/no.py b/sphinx/search/no.py index 67c338675..f11f3cf15 100644 --- a/sphinx/search/no.py +++ b/sphinx/search/no.py @@ -1,5 +1,4 @@ -"""Norwegian search language: includes the JS Norwegian stemmer. -""" +"""Norwegian search language: includes the JS Norwegian stemmer.""" from typing import Dict diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py index 84408e795..1708928b2 100644 --- a/sphinx/search/pt.py +++ b/sphinx/search/pt.py @@ -1,5 +1,4 @@ -"""Portuguese search language: includes the JS Portuguese stemmer. -""" +"""Portuguese search language: includes the JS Portuguese stemmer.""" from typing import Dict diff --git a/sphinx/search/ro.py b/sphinx/search/ro.py index 46426f25e..4c8a22711 100644 --- a/sphinx/search/ro.py +++ b/sphinx/search/ro.py @@ -1,5 +1,4 @@ -"""Romanian search language: includes the JS Romanian stemmer. -""" +"""Romanian search language: includes the JS Romanian stemmer.""" from typing import Dict, Set diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index 778f18da6..6c4f8da94 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -1,5 +1,4 @@ -"""Russian search language: includes the JS Russian stemmer. -""" +"""Russian search language: includes the JS Russian stemmer.""" from typing import Dict diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py index b74d8980f..176cc8da4 100644 --- a/sphinx/search/sv.py +++ b/sphinx/search/sv.py @@ -1,5 +1,4 @@ -"""Swedish search language: includes the JS Swedish stemmer. -""" +"""Swedish search language: includes the JS Swedish stemmer.""" from typing import Dict diff --git a/sphinx/search/tr.py b/sphinx/search/tr.py index 1338c7116..78d48aed0 100644 --- a/sphinx/search/tr.py +++ b/sphinx/search/tr.py @@ -1,5 +1,4 @@ -"""Turkish search language: includes the JS Turkish stemmer. -""" +"""Turkish search language: includes the JS Turkish stemmer.""" from typing import Dict, Set diff --git a/sphinx/search/zh.py b/sphinx/search/zh.py index 46f486bd3..700c2683f 100644 --- a/sphinx/search/zh.py +++ b/sphinx/search/zh.py @@ -1,5 +1,4 @@ -"""Chinese search language: includes routine to split words. -""" +"""Chinese search language: includes routine to split words.""" import os import re diff --git a/sphinx/testing/comparer.py b/sphinx/testing/comparer.py index 370bd264d..09e8364bd 100644 --- a/sphinx/testing/comparer.py +++ b/sphinx/testing/comparer.py @@ -1,5 +1,4 @@ -"""Sphinx test comparer for pytest -""" +"""Sphinx test comparer for pytest""" import difflib import pathlib from typing import Any, List, Union diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py index 2f00ca974..0b558e32c 100644 --- a/sphinx/testing/fixtures.py +++ b/sphinx/testing/fixtures.py @@ -1,5 +1,4 @@ -"""Sphinx test fixtures for pytest -""" +"""Sphinx test fixtures for pytest""" import subprocess import sys diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py index bea449257..441e6da3b 100644 --- a/sphinx/testing/util.py +++ b/sphinx/testing/util.py @@ -1,5 +1,4 @@ -"""Sphinx test suite utilities -""" +"""Sphinx test suite utilities""" import functools import os import re diff --git a/sphinx/theming.py b/sphinx/theming.py index 3b662dd00..6b8f79c3d 100644 --- a/sphinx/theming.py +++ b/sphinx/theming.py @@ -1,5 +1,4 @@ -"""Theming support for HTML builders. -""" +"""Theming support for HTML builders.""" import configparser import os diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py index 3fa74c45b..a2a592221 100644 --- a/sphinx/transforms/__init__.py +++ b/sphinx/transforms/__init__.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx when reading documents. -""" +"""Docutils transforms used by Sphinx when reading documents.""" import re import unicodedata diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py index b35df3cb1..4bf633237 100644 --- a/sphinx/transforms/compact_bullet_list.py +++ b/sphinx/transforms/compact_bullet_list.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx when reading documents. -""" +"""Docutils transforms used by Sphinx when reading documents.""" from typing import Any, Dict, List, cast diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py index a45ec02d1..4909cebc1 100644 --- a/sphinx/transforms/i18n.py +++ b/sphinx/transforms/i18n.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx when reading documents. -""" +"""Docutils transforms used by Sphinx when reading documents.""" from os import path from textwrap import indent diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py index 9b3c84edf..94a162963 100644 --- a/sphinx/transforms/post_transforms/__init__.py +++ b/sphinx/transforms/post_transforms/__init__.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx. -""" +"""Docutils transforms used by Sphinx.""" import re from typing import Any, Dict, List, Optional, Sequence, Tuple, Type, cast diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index a47555bd1..3c3f54328 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -1,5 +1,4 @@ -"""transforms for code-blocks. -""" +"""transforms for code-blocks.""" import sys from typing import Any, Dict, List, NamedTuple diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py index 3f2c99b0f..ac9c4225e 100644 --- a/sphinx/transforms/post_transforms/images.py +++ b/sphinx/transforms/post_transforms/images.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx. -""" +"""Docutils transforms used by Sphinx.""" import os import re diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py index da899f952..647c83e12 100644 --- a/sphinx/transforms/references.py +++ b/sphinx/transforms/references.py @@ -1,5 +1,4 @@ -"""Docutils transforms used by Sphinx. -""" +"""Docutils transforms used by Sphinx.""" from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 9dd30289a..ee98c29c8 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -1,5 +1,4 @@ -"""Utility functions for Sphinx. -""" +"""Utility functions for Sphinx.""" import functools import hashlib diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py index 8a45eabb2..7f80aa576 100644 --- a/sphinx/util/build_phase.py +++ b/sphinx/util/build_phase.py @@ -1,5 +1,4 @@ -"""Build phase of Sphinx application. -""" +"""Build phase of Sphinx application.""" from enum import IntEnum diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py index c382a5634..38dc3fd21 100644 --- a/sphinx/util/cfamily.py +++ b/sphinx/util/cfamily.py @@ -1,5 +1,4 @@ -"""Utility functions common to the C and C++ domains. -""" +"""Utility functions common to the C and C++ domains.""" import re from copy import deepcopy diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 58ca9e1b0..7f332fda7 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -1,5 +1,4 @@ -"""modules for backward compatibility -""" +"""modules for backward compatibility""" import sys from typing import TYPE_CHECKING, Any, Dict diff --git a/sphinx/util/console.py b/sphinx/util/console.py index 22bb01514..cc22390a5 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -1,5 +1,4 @@ -"""Format colored console output. -""" +"""Format colored console output.""" import os import re diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index d952fa11b..11c823b33 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,5 +1,4 @@ -"""Utilities for docstring processing. -""" +"""Utilities for docstring processing.""" import re import sys diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index 07a17be79..654a7a98b 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -1,5 +1,4 @@ -"""Utility functions for docutils. -""" +"""Utility functions for docutils.""" import os import re diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py index c3ce9633c..f706fa69a 100644 --- a/sphinx/util/fileutil.py +++ b/sphinx/util/fileutil.py @@ -1,5 +1,4 @@ -"""File utility functions for Sphinx. -""" +"""File utility functions for Sphinx.""" import os import posixpath diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py index a7706e899..f3bb002a3 100644 --- a/sphinx/util/i18n.py +++ b/sphinx/util/i18n.py @@ -1,5 +1,4 @@ -"""Builder superclass for all builders. -""" +"""Builder superclass for all builders.""" import os import re diff --git a/sphinx/util/images.py b/sphinx/util/images.py index a6d0918a0..2def252f4 100644 --- a/sphinx/util/images.py +++ b/sphinx/util/images.py @@ -1,5 +1,4 @@ -"""Image utility functions for Sphinx. -""" +"""Image utility functions for Sphinx.""" import base64 import imghdr diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index c9a4eb725..5b4e2586e 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -1,5 +1,4 @@ -"""Helpers for inspecting Python modules. -""" +"""Helpers for inspecting Python modules.""" import builtins import contextlib diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py index d46a0916d..7827aec74 100644 --- a/sphinx/util/inventory.py +++ b/sphinx/util/inventory.py @@ -1,5 +1,4 @@ -"""Inventory utility functions for Sphinx. -""" +"""Inventory utility functions for Sphinx.""" import os import re import zlib diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py index 3e1dad784..37fa672af 100644 --- a/sphinx/util/logging.py +++ b/sphinx/util/logging.py @@ -1,5 +1,4 @@ -"""Logging utility functions for Sphinx. -""" +"""Logging utility functions for Sphinx.""" import logging import logging.handlers diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index 4aede2763..53a893338 100644 --- a/sphinx/util/matching.py +++ b/sphinx/util/matching.py @@ -1,5 +1,4 @@ -"""Pattern-matching utility functions for Sphinx. -""" +"""Pattern-matching utility functions for Sphinx.""" import re from typing import Callable, Dict, Iterable, List, Match, Optional, Pattern diff --git a/sphinx/util/math.py b/sphinx/util/math.py index 56523e10f..7caf662dc 100644 --- a/sphinx/util/math.py +++ b/sphinx/util/math.py @@ -1,5 +1,4 @@ -"""Utility functions for math. -""" +"""Utility functions for math.""" from docutils import nodes diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index aff3d1875..4abc3afa4 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -1,5 +1,4 @@ -"""Docutils node-related utility functions for Sphinx. -""" +"""Docutils node-related utility functions for Sphinx.""" import re import unicodedata diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index 7ce114aa0..1af722fdc 100644 --- a/sphinx/util/osutil.py +++ b/sphinx/util/osutil.py @@ -1,5 +1,4 @@ -"""Operating system-related utility functions for Sphinx. -""" +"""Operating system-related utility functions for Sphinx.""" import contextlib import filecmp diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index 39a5c741c..e4bd852b0 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -1,5 +1,4 @@ -"""Parallel building utilities. -""" +"""Parallel building utilities.""" import os import time diff --git a/sphinx/util/png.py b/sphinx/util/png.py index 0234ab9fd..cb7ee8be4 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -1,5 +1,4 @@ -"""PNG image manipulation helpers. -""" +"""PNG image manipulation helpers.""" import binascii import struct diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index 51f5af90d..aedbd143d 100644 --- a/sphinx/util/pycompat.py +++ b/sphinx/util/pycompat.py @@ -1,5 +1,4 @@ -"""Stuff for Python version compatibility. -""" +"""Stuff for Python version compatibility.""" import warnings from typing import Any, Callable diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py index 834274df2..b1bcb6bd3 100644 --- a/sphinx/util/requests.py +++ b/sphinx/util/requests.py @@ -1,5 +1,4 @@ -"""Simple requests package loader -""" +"""Simple requests package loader""" import sys import warnings diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index aa9b335bc..b44cf9848 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -1,5 +1,4 @@ -"""reST helper functions. -""" +"""reST helper functions.""" import re from collections import defaultdict diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py index 16a8d7ac8..ff6c365c7 100644 --- a/sphinx/util/stemmer/__init__.py +++ b/sphinx/util/stemmer/__init__.py @@ -1,5 +1,4 @@ -"""Word stemming utilities for Sphinx. -""" +"""Word stemming utilities for Sphinx.""" from sphinx.util.stemmer.porter import PorterStemmer diff --git a/sphinx/util/template.py b/sphinx/util/template.py index 803fd4bad..5a73515b3 100644 --- a/sphinx/util/template.py +++ b/sphinx/util/template.py @@ -1,5 +1,4 @@ -"""Templates utility functions for Sphinx. -""" +"""Templates utility functions for Sphinx.""" import os from functools import partial diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index b25cb62c3..83c78bb38 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -1,5 +1,4 @@ -"""TeX escaping helper. -""" +"""TeX escaping helper.""" import re from typing import Dict diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py index 203205990..1534b2c8e 100644 --- a/sphinx/util/typing.py +++ b/sphinx/util/typing.py @@ -1,5 +1,4 @@ -"""The composite types for Sphinx. -""" +"""The composite types for Sphinx.""" import sys import typing diff --git a/sphinx/versioning.py b/sphinx/versioning.py index d34cf4df3..06cf33cc0 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -1,5 +1,4 @@ -"""Implements the low-level algorithms Sphinx uses for versioning doctrees. -""" +"""Implements the low-level algorithms Sphinx uses for versioning doctrees.""" import pickle from itertools import product, zip_longest from operator import itemgetter diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py index 30487d18e..e90088e6d 100644 --- a/sphinx/writers/__init__.py +++ b/sphinx/writers/__init__.py @@ -1,2 +1 @@ -"""Custom docutils writers. -""" +"""Custom docutils writers.""" diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index d5b1ad30a..49a4b0349 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -1,5 +1,4 @@ -"""docutils writers handling Sphinx' custom nodes. -""" +"""docutils writers handling Sphinx' custom nodes.""" import os import posixpath diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index bff8fcd09..43d403e6d 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -1,5 +1,4 @@ -"""Experimental docutils writers for HTML5 handling Sphinx's custom nodes. -""" +"""Experimental docutils writers for HTML5 handling Sphinx's custom nodes.""" import os import posixpath diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index 7f97c52d3..10e91f4a3 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -1,5 +1,4 @@ -"""Manual page writer, extended for Sphinx custom nodes. -""" +"""Manual page writer, extended for Sphinx custom nodes.""" from typing import Any, Dict, Iterable, cast diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index 5a14cab45..b40f032b4 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -1,5 +1,4 @@ -"""Custom docutils writer for Texinfo. -""" +"""Custom docutils writer for Texinfo.""" import re import textwrap diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 7dc199354..8df01012c 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -1,5 +1,4 @@ -"""Custom docutils writer for plain text. -""" +"""Custom docutils writer for plain text.""" import math import os import re diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py index b3cd19edc..5f9aad7fa 100644 --- a/sphinx/writers/xml.py +++ b/sphinx/writers/xml.py @@ -1,5 +1,4 @@ -"""Docutils-native XML and pseudo-XML writers. -""" +"""Docutils-native XML and pseudo-XML writers.""" from typing import Any |