Collapse single line docstrings

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.)

sphinx/__main__.py

@@ -1,5 +1,4 @@
-"""The Sphinx documentation toolchain.
-"""
+"""The Sphinx documentation toolchain."""
 
 import sys
 

sphinx/addnodes.py

@@ -1,5 +1,4 @@
-"""Additional docutils nodes.
-"""
+"""Additional docutils nodes."""
 
 from typing import TYPE_CHECKING, Any, Dict, List, Sequence
 

sphinx/builders/__init__.py

@@ -1,5 +1,4 @@
-"""Builder superclass for all builders.
-"""
+"""Builder superclass for all builders."""
 
 import pickle
 import time

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

sphinx/builders/changes.py

@@ -1,5 +1,4 @@
-"""Changelog builder.
-"""
+"""Changelog builder."""
 
 import html
 from os import path

sphinx/builders/dirhtml.py

@@ -1,5 +1,4 @@
-"""Directory HTML builders.
-"""
+"""Directory HTML builders."""
 
 from os import path
 from typing import Any, Dict

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
 

sphinx/builders/gettext.py

@@ -1,5 +1,4 @@
-"""The MessageCatalogBuilder class.
-"""
+"""The MessageCatalogBuilder class."""
 
 from codecs import open
 from collections import OrderedDict, defaultdict

sphinx/builders/html/__init__.py

@@ -1,5 +1,4 @@
-"""Several HTML builders.
-"""
+"""Several HTML builders."""
 
 import html
 import os

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

sphinx/builders/latex/__init__.py

@@ -1,5 +1,4 @@
-"""LaTeX builder.
-"""
+"""LaTeX builder."""
 
 import os
 import warnings

sphinx/builders/latex/constants.py

@@ -1,5 +1,4 @@
-"""consntants for LaTeX builder.
-"""
+"""consntants for LaTeX builder."""
 
 from typing import Any, Dict
 

sphinx/builders/latex/nodes.py

@@ -1,5 +1,4 @@
-"""Additional nodes for LaTeX writer.
-"""
+"""Additional nodes for LaTeX writer."""
 
 from docutils import nodes
 

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

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
 

sphinx/builders/latex/util.py

@@ -1,5 +1,4 @@
-"""Utilities for LaTeX builder.
-"""
+"""Utilities for LaTeX builder."""
 
 from typing import Optional
 

sphinx/builders/linkcheck.py

@@ -1,5 +1,4 @@
-"""The CheckExternalLinksBuilder class.
-"""
+"""The CheckExternalLinksBuilder class."""
 
 import json
 import re

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

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

sphinx/builders/texinfo.py

@@ -1,5 +1,4 @@
-"""Texinfo builder.
-"""
+"""Texinfo builder."""
 
 import os
 from os import path

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

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

sphinx/cmd/__init__.py

@@ -1,2 +1 @@
-"""Modules for command line executables.
-"""
+"""Modules for command line executables."""

sphinx/cmd/build.py

@@ -1,5 +1,4 @@
-"""Build documentation from a provided source.
-"""
+"""Build documentation from a provided source."""
 
 import argparse
 import bdb

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

sphinx/config.py

@@ -1,5 +1,4 @@
-"""Build configuration file handling.
-"""
+"""Build configuration file handling."""
 
 import re
 import traceback

sphinx/deprecation.py

@@ -1,5 +1,4 @@
-"""Sphinx deprecation classes and utilities.
-"""
+"""Sphinx deprecation classes and utilities."""
 
 import sys
 import warnings

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

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,

sphinx/domains/changeset.py

@@ -1,5 +1,4 @@
-"""The changeset domain.
-"""
+"""The changeset domain."""
 
 from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, cast
 

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
 

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,

sphinx/domains/index.py

@@ -1,5 +1,4 @@
-"""The index domain.
-"""
+"""The index domain."""
 
 from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Tuple
 

sphinx/domains/javascript.py

@@ -1,5 +1,4 @@
-"""The JavaScript domain.
-"""
+"""The JavaScript domain."""
 
 from typing import Any, Dict, Iterator, List, Optional, Tuple, cast
 

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
 

sphinx/domains/python.py

@@ -1,5 +1,4 @@
-"""The Python domain.
-"""
+"""The Python domain."""
 
 import builtins
 import inspect

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

sphinx/domains/std.py

@@ -1,5 +1,4 @@
-"""The standard domain.
-"""
+"""The standard domain."""
 
 import re
 import warnings

sphinx/environment/__init__.py

@@ -1,5 +1,4 @@
-"""Global creation environment.
-"""
+"""Global creation environment."""
 
 import os
 import pickle

sphinx/environment/adapters/__init__.py

@@ -1,2 +1 @@
-"""Sphinx environment adapters
-"""
+"""Sphinx environment adapters"""

sphinx/environment/adapters/asset.py

@@ -1,5 +1,4 @@
-"""Assets adapter for sphinx.environment.
-"""
+"""Assets adapter for sphinx.environment."""
 
 from sphinx.environment import BuildEnvironment
 

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

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
 

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
 

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

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

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
 

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
 

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
 

sphinx/errors.py

@@ -1,5 +1,4 @@
-"""Contains SphinxError and a few subclasses.
-"""
+"""Contains SphinxError and a few subclasses."""
 
 from typing import Any
 

sphinx/ext/__init__.py

@@ -1,2 +1 @@
-"""Contains Sphinx features not activated by default.
-"""
+"""Contains Sphinx features not activated by default."""

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

sphinx/ext/autodoc/importer.py

@@ -1,5 +1,4 @@
-"""Importer utilities for autodoc
-"""
+"""Importer utilities for autodoc"""
 
 import importlib
 import traceback

sphinx/ext/autodoc/mock.py

@@ -1,5 +1,4 @@
-"""mock for autodoc
-"""
+"""mock for autodoc"""
 
 import contextlib
 import os

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

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

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
 

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

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

sphinx/ext/imgconverter.py

@@ -1,5 +1,4 @@
-"""Image converter extension for Sphinx
-"""
+"""Image converter extension for Sphinx"""
 
 import subprocess
 import sys

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

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
 

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
 

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

sphinx/extension.py

@@ -1,5 +1,4 @@
-"""Utilities for Sphinx extensions.
-"""
+"""Utilities for Sphinx extensions."""
 
 from typing import TYPE_CHECKING, Any, Dict
 

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

sphinx/io.py

@@ -1,5 +1,4 @@
-"""Input/Output files
-"""
+"""Input/Output files"""
 import codecs
 from typing import TYPE_CHECKING, Any, List, Type
 

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

sphinx/locale/__init__.py

@@ -1,5 +1,4 @@
-"""Locale utilities.
-"""
+"""Locale utilities."""
 
 import gettext
 import locale

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

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

sphinx/pycode/__init__.py

@@ -1,5 +1,4 @@
-"""Utilities parsing and analyzing Python code.
-"""
+"""Utilities parsing and analyzing Python code."""
 
 import re
 import tokenize

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

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

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

sphinx/registry.py

@@ -1,5 +1,4 @@
-"""Sphinx component registry.
-"""
+"""Sphinx component registry."""
 
 import traceback
 import warnings

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

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

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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/)

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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

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

sphinx/testing/fixtures.py

@@ -1,5 +1,4 @@
-"""Sphinx test fixtures for pytest
-"""
+"""Sphinx test fixtures for pytest"""
 
 import subprocess
 import sys

sphinx/testing/util.py

@@ -1,5 +1,4 @@
-"""Sphinx test suite utilities
-"""
+"""Sphinx test suite utilities"""
 import functools
 import os
 import re

sphinx/theming.py

@@ -1,5 +1,4 @@
-"""Theming support for HTML builders.
-"""
+"""Theming support for HTML builders."""
 
 import configparser
 import os