diff options
Diffstat (limited to 'sphinx/util')
30 files changed, 30 insertions, 60 deletions
diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 554ade0cb..d6454735d 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -1,5 +1,4 @@ -""" - Utility functions for Sphinx. +"""Utility functions for Sphinx. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py index 68cdb6a31..4f7bf1a75 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py index 6b9b05966..0772bee20 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 0f644b838..8d5eed46e 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -1,5 +1,4 @@ -""" - modules for backward compatibility +"""modules for backward compatibility :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/console.py b/sphinx/util/console.py index 62e4d297e..b391d524b 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -1,5 +1,4 @@ -""" - Format colored console output. +"""Format colored console output. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index f81f80948..adabab9c8 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -1,5 +1,4 @@ -""" - "Doc fields" are reST field lists in object descriptions that will +""""Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index f634b438b..57ae47e86 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,5 +1,4 @@ -""" - Utilities for docstring processing. +"""Utilities for docstring processing. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index 90f00ddd5..64726fcee 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -1,5 +1,4 @@ -""" - Utility functions for docutils. +"""Utility functions for docutils. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py index 7e412e2ec..e633f77bd 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py index 0e0621fcd..5e5cbec8a 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/images.py b/sphinx/util/images.py index 508617ca6..05572ec29 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 9a66c0ec6..2d6aac13b 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py index dfc3cd7ba..e8e5e480e 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index 935a26119..0cad261ce 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -1,5 +1,4 @@ -""" - This module implements a simple JavaScript serializer. +"""This module implements a simple JavaScript serializer. Uses the basestring encode function from simplejson by Bob Ippolito. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py index b78707afe..a0c09bb20 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index e8c000ee1..c84cd757f 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/math.py b/sphinx/util/math.py index 0fa945890..0addaa5a0 100644 --- a/sphinx/util/math.py +++ b/sphinx/util/math.py @@ -1,5 +1,4 @@ -""" - Utility functions for math. +"""Utility functions for math. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index 3af9f4dd7..b19597041 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index e346170f0..e0d736229 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index 3783db7fc..5a63fb9e9 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -1,5 +1,4 @@ -""" - Parallel building utilities. +"""Parallel building utilities. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/png.py b/sphinx/util/png.py index ba9794f62..cb0f86eb9 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -1,5 +1,4 @@ -""" - PNG image manipulation helpers. +"""PNG image manipulation helpers. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index 639ccb5ab..a8b105cc7 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py index 78b947ce8..8241bc60b 100644 --- a/sphinx/util/requests.py +++ b/sphinx/util/requests.py @@ -1,5 +1,4 @@ -""" - Simple requests package loader +"""Simple requests package loader :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index 3cb9d64ba..8b0f05507 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -1,5 +1,4 @@ -""" - reST helper functions. +"""reST helper functions. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/smartypants.py b/sphinx/util/smartypants.py index 512ab839a..363a4c97b 100644 --- a/sphinx/util/smartypants.py +++ b/sphinx/util/smartypants.py @@ -1,5 +1,4 @@ -""" - This is extracted (with minor adaptations for flake8 compliance) from +"""This is extracted (with minor adaptations for flake8 compliance) from docutils’ docutils/utils/smartquotes.py as of revision 8097 (30 May 2017), in order to backport for Sphinx usage with Docutils < 0.14 extra language configurations and fixes. Replaces earlier smartypants version as used up diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py index 0332e3f3b..d7576a94e 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/stemmer/porter.py b/sphinx/util/stemmer/porter.py index e26431646..6068e76ab 100644 --- a/sphinx/util/stemmer/porter.py +++ b/sphinx/util/stemmer/porter.py @@ -1,5 +1,4 @@ -""" - Porter Stemming Algorithm +"""Porter Stemming Algorithm This is the Porter stemming algorithm, ported to Python from the version coded up in ANSI C by the author. It may be be regarded diff --git a/sphinx/util/template.py b/sphinx/util/template.py index c684b8589..2fcd1f245 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index 92b07521f..c9e421022 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -1,5 +1,4 @@ -""" - TeX escaping helper. +"""TeX escaping helper. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py index df5c9f6e8..0cffd94ff 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. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. |