Merge pull request #10212 from AA-Turner/remove-module-docstring-titles

Remove module docstring titles
This commit is contained in:
Takeshi KOMIYA
2022-03-14 02:14:17 +09:00
committed by GitHub
285 changed files with 448 additions and 2726 deletions

View File

@@ -1,11 +1,3 @@
"""
pytest config for sphinx/tests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import os
import shutil

View File

@@ -1,6 +1,4 @@
"""
Test module for napoleon PEP 526 compatibility with google style
"""
"""Test module for napoleon PEP 526 compatibility with google style"""
module_level_var: int = 99
"""This is an example module level variable"""

View File

@@ -1,6 +1,4 @@
"""
Test module for napoleon PEP 526 compatibility with numpy style
"""
"""Test module for napoleon PEP 526 compatibility with numpy style"""
module_level_var: int = 99
"""This is an example module level variable"""

View File

@@ -1,5 +1,4 @@
"""
Test with nested classes.
"""Test with nested classes.
"""

View File

@@ -1,12 +1,4 @@
"""
test_api_translator
~~~~~~~~~~~~~~~~~~~
Test the Sphinx API for translator.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the Sphinx API for translator."""
import sys

View File

@@ -1,12 +1,4 @@
"""
test_application
~~~~~~~~~~~~~~~~
Test the Sphinx class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the Sphinx class."""
from unittest.mock import Mock

View File

@@ -1,12 +1,4 @@
"""
test_build
~~~~~~~~~~
Test all builders.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test all builders."""
import sys
from textwrap import dedent

View File

@@ -1,12 +1,4 @@
"""
test_build_changes
~~~~~~~~~~~~~~~~~~
Test the ChangesBuilder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the ChangesBuilder class."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_build_dirhtml
~~~~~~~~~~~~~~~~~~
Test dirhtml builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test dirhtml builder."""
import posixpath

View File

@@ -1,12 +1,4 @@
"""
test_build_html
~~~~~~~~~~~~~~~
Test the HTML builder and check output against XPath.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the HTML builder and check output against XPath."""
import os
import subprocess

View File

@@ -1,12 +1,4 @@
"""
test_build_gettext
~~~~~~~~~~~~~~~~~~
Test the build process with gettext builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the build process with gettext builder with the test root."""
import gettext
import os

View File

@@ -1,12 +1,4 @@
"""
test_build_html
~~~~~~~~~~~~~~~
Test the HTML builder and check output against XPath.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the HTML builder and check output against XPath."""
import os
import re

View File

@@ -1,12 +1,4 @@
"""
test_build_latex
~~~~~~~~~~~~~~~~
Test the build process with LaTeX builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the build process with LaTeX builder with the test root."""
import os
import re

View File

@@ -1,12 +1,4 @@
"""
test_build_linkcheck
~~~~~~~~~~~~~~~~~~~~
Test the build process with manpage builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the build process with manpage builder with the test root."""
import http.server
import json

View File

@@ -1,12 +1,4 @@
"""
test_build_manpage
~~~~~~~~~~~~~~~~~~
Test the build process with manpage builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the build process with manpage builder with the test root."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_build_texinfo
~~~~~~~~~~~~~~~~~~
Test the build process with Texinfo builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the build process with Texinfo builder with the test root."""
import os
import re

View File

@@ -1,12 +1,4 @@
"""
test_build_text
~~~~~~~~~~~~~~~
Test the build process with Text builder with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the build process with Text builder with the test root."""
import pytest
from docutils.utils import column_width

View File

@@ -1,12 +1,4 @@
"""
test_builder
~~~~~~~~
Test the Builder class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the Builder class."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_build_base
~~~~~~~~~~~~~~~
Test the base build process.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the base build process."""
import shutil
import pytest

View File

@@ -1,13 +1,4 @@
"""
test_config
~~~~~~~~~~~
Test the sphinx.config.Config class and its handling in the
Application class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the sphinx.config.Config class."""
from unittest import mock

View File

@@ -1,12 +1,4 @@
"""
test_correct_year
~~~~~~~~~~~~~~~~~
Test copyright year adjustment
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test copyright year adjustment"""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_directive_code
~~~~~~~~~~~~~~~~~~~
Test the code-block directive.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the code-block directive."""
import os

View File

@@ -1,12 +1,4 @@
"""
test_only_directive
~~~~~~~~~~~~~~~~~~~
Test the only directive with the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the only directive with the test root."""
import re

View File

@@ -1,12 +1,4 @@
"""
test_directive_other
~~~~~~~~~~~~~~~~~~~~
Test the other directives.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the other directives."""
import pytest
from docutils import nodes

View File

@@ -1,12 +1,4 @@
"""
test_directive_patch
~~~~~~~~~~~~~~~~~~~
Test the patched directives.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the patched directives."""
import pytest
from docutils import nodes

View File

@@ -1,12 +1,4 @@
"""
test_docutilsconf
~~~~~~~~~~~~~~~~~
Test docutils.conf support for several writers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test docutils.conf support for several writers."""
import pytest
from docutils import nodes

View File

@@ -1,12 +1,4 @@
"""
test_domain_c
~~~~~~~~~~~~~
Tests the C Domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests the C Domain"""
import itertools
import zlib

View File

@@ -1,12 +1,4 @@
"""
test_domain_cpp
~~~~~~~~~~~~~~~
Tests the C++ Domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests the C++ Domain"""
import itertools
import re

View File

@@ -1,12 +1,4 @@
"""
test_domain_js
~~~~~~~~~~~~~~
Tests the JavaScript Domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests the JavaScript Domain"""
from unittest.mock import Mock

View File

@@ -1,12 +1,4 @@
"""
test_domain_py
~~~~~~~~~~~~~~
Tests the Python Domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests the Python Domain"""
import re
import sys

View File

@@ -1,12 +1,4 @@
"""
test_rst_domain
~~~~~~~~~~~~~~~
Tests the reStructuredText domain.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests the reStructuredText domain."""
from sphinx import addnodes
from sphinx.addnodes import (desc, desc_addname, desc_annotation, desc_content, desc_name,

View File

@@ -1,12 +1,4 @@
"""
test_domain_std
~~~~~~~~~~~~~~~
Tests the std domain
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests the std domain"""
from unittest import mock

View File

@@ -1,12 +1,4 @@
"""
test_env
~~~~~~~~
Test the BuildEnvironment class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the BuildEnvironment class."""
import os
import shutil

View File

@@ -1,12 +1,4 @@
"""
test_environment_indexentries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Test the sphinx.environment.managers.indexentries.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the sphinx.environment.managers.indexentries."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_environment_toctree
~~~~~~~~~~~~~~~~~~~~~~~~
Test the sphinx.environment.managers.toctree.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the sphinx.environment.managers.toctree."""
import pytest
from docutils import nodes

View File

@@ -1,12 +1,4 @@
"""
test_events
~~~~~~~~~~~
Test the EventManager class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the EventManager class."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_apidoc
~~~~~~~~~~~
Test the sphinx.apidoc module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the sphinx.apidoc module."""
from collections import namedtuple

View File

@@ -1,12 +1,7 @@
"""
test_ext_autodoc
~~~~~~~~~~~~~~~~
"""Test the autodoc extension.
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
This tests mainly the Documenters; the auto directives are tested in a test
source file translated by test_build.
"""
import sys

View File

@@ -1,12 +1,7 @@
"""
test_ext_autodoc_autoattribute
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"""Test the autodoc extension.
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
This tests mainly the Documenters; the auto directives are tested in a test
source file translated by test_build.
"""
import sys

View File

@@ -1,12 +1,7 @@
"""
test_ext_autodoc_autoclass
~~~~~~~~~~~~~~~~~~~~~~~~~~
"""Test the autodoc extension.
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
This tests mainly the Documenters; the auto directives are tested in a test
source file translated by test_build.
"""
import sys

View File

@@ -1,12 +1,7 @@
"""
test_ext_autodoc_autodata
~~~~~~~~~~~~~~~~~~~~~~~~~
"""Test the autodoc extension.
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
This tests mainly the Documenters; the auto directives are tested in a test
source file translated by test_build.
"""
import sys

View File

@@ -1,12 +1,7 @@
"""
test_ext_autodoc_autofunction
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"""Test the autodoc extension.
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
This tests mainly the Documenters; the auto directives are tested in a test
source file translated by test_build.
"""
import pytest

View File

@@ -1,12 +1,7 @@
"""
test_ext_autodoc_autocmodule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"""Test the autodoc extension.
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
This tests mainly the Documenters; the auto directives are tested in a test
source file translated by test_build.
"""
import sys

View File

@@ -1,12 +1,7 @@
"""
test_ext_autodoc_autoproperty
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"""Test the autodoc extension.
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
This tests mainly the Documenters; the auto directives are tested in a test
source file translated by test_build.
"""
import sys

View File

@@ -1,12 +1,4 @@
"""
test_ext_autodoc_configs
~~~~~~~~~~~~~~~~~~~~~~~~
Test the autodoc extension. This tests mainly for config variables
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the autodoc extension. This tests mainly for config variables"""
import platform
import sys

View File

@@ -1,12 +1,4 @@
"""
test_ext_autodoc_events
~~~~~~~~~~~~~~~~~~~~~~~
Test the autodoc extension. This tests mainly for autodoc events
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the autodoc extension. This tests mainly for autodoc events"""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_ext_autodoc_mock
~~~~~~~~~~~~~~~~~~~~~
Test the autodoc extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the autodoc extension."""
import abc
import sys

View File

@@ -1,12 +1,4 @@
"""
test_ext_autodoc_preserve_defaults
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Test the autodoc extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the autodoc extension."""
import sys

View File

@@ -1,11 +1,4 @@
"""
test_ext_autodoc_private_members
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Test the autodoc extension. This tests mainly for private-members option.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""Test the autodoc extension. This tests mainly for private-members option.
"""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_ext_autosectionlabel
~~~~~~~~~~~~~~~~~~~~~~~~~
Test sphinx.ext.autosectionlabel extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.autosectionlabel extension."""
import re

View File

@@ -1,12 +1,4 @@
"""
test_autosummary
~~~~~~~~~~~~~~~~
Test the autosummary extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the autosummary extension."""
import sys
from io import StringIO

View File

@@ -1,12 +1,4 @@
"""
test_coverage
~~~~~~~~~~~~~
Test the coverage builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the coverage builder."""
import pickle

View File

@@ -1,12 +1,4 @@
"""
test_doctest
~~~~~~~~~~~~
Test the doctest extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the doctest extension."""
import os
from collections import Counter

View File

@@ -1,12 +1,4 @@
"""
test_ext_duration
~~~~~~~~~~~~~~~~~
Test sphinx.ext.duration extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.duration extension."""
import re

View File

@@ -1,12 +1,4 @@
"""
test_ext_githubpages
~~~~~~~~~~~~~~~~~~~~
Test sphinx.ext.githubpages extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.githubpages extension."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_ext_graphviz
~~~~~~~~~~~~~~~~~
Test sphinx.ext.graphviz extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.graphviz extension."""
import re

View File

@@ -1,12 +1,4 @@
"""
test_ext_ifconfig
~~~~~~~~~~~~~~~~~
Test sphinx.ext.ifconfig extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.ifconfig extension."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_ext_imgconverter
~~~~~~~~~~~~~~~~~~~~~
Test sphinx.ext.imgconverter extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.imgconverter extension."""
import os

View File

@@ -1,12 +1,4 @@
"""
test_ext_inheritance_diagram
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Test sphinx.ext.inheritance_diagram extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.inheritance_diagram extension."""
import os
import re

View File

@@ -1,12 +1,4 @@
"""
test_intersphinx
~~~~~~~~~~~~~~~~
Test the intersphinx extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the intersphinx extension."""
import http.server
import os

View File

@@ -1,12 +1,4 @@
"""
test_ext_math
~~~~~~~~~~~~~
Test math extensions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test math extensions."""
import re
import subprocess

View File

@@ -1,13 +1,4 @@
"""
test_napoleon
~~~~~~~~~~~~~
Tests for :mod:`sphinx.ext.napoleon.__init__` module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests for :mod:`sphinx.ext.napoleon.__init__` module."""
import sys
from collections import namedtuple

View File

@@ -1,13 +1,4 @@
"""
test_napoleon_docstring
~~~~~~~~~~~~~~~~~~~~~~~
Tests for :mod:`sphinx.ext.napoleon.docstring` module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests for :mod:`sphinx.ext.napoleon.docstring` module."""
import re
import sys

View File

@@ -1,13 +1,4 @@
"""
test_napoleon_iterators
~~~~~~~~~~~~~~~~~~~~~~~
Tests for :mod:`sphinx.ext.napoleon.iterators` module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests for :mod:`sphinx.ext.napoleon.iterators` module."""
from unittest import TestCase

View File

@@ -1,12 +1,4 @@
"""
test_ext_todo
~~~~~~~~~~~~~
Test sphinx.ext.todo extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.todo extension."""
import re

View File

@@ -1,12 +1,4 @@
"""
test_ext_viewcode
~~~~~~~~~~~~~~~~~
Test sphinx.ext.viewcode extension.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.ext.viewcode extension."""
import re

View File

@@ -1,12 +1,4 @@
"""
test_extension
~~~~~~~~~~~~~~
Test sphinx.extension module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.extension module."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_highlighting
~~~~~~~~~~~~~~~~~
Test the Pygments highlighting bridge.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the Pygments highlighting bridge."""
from unittest import mock

View File

@@ -1,12 +1,6 @@
"""
test_intl
~~~~~~~~~
"""Test message patching for internationalization purposes.
Test message patching for internationalization purposes. Runs the text
builder in the test root.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
Runs the text builder in the test root.
"""
import os

View File

@@ -1,12 +1,4 @@
"""
test_locale
~~~~~~~~~~
Test locale.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test locale."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_markup
~~~~~~~~~~~
Test various Sphinx-specific markup extensions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test various Sphinx-specific markup extensions."""
import re

View File

@@ -1,12 +1,4 @@
"""
test_metadata
~~~~~~~~~~~~~
Test our handling of metadata in files with bibliographic metadata.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test our handling of metadata in files with bibliographic metadata."""
# adapted from an example of bibliographic metadata at
# https://docutils.sourceforge.io/docs/user/rst/demo.txt

View File

@@ -1,12 +1,4 @@
"""
test_sphinx_parsers
~~~~~~~~~~~~~~~~~~~
Tests parsers module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests parsers module."""
from unittest.mock import Mock, patch

View File

@@ -1,12 +1,4 @@
"""
test_project
~~~~~~~~~~~~
Tests project module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests project module."""
from collections import OrderedDict

View File

@@ -1,12 +1,4 @@
"""
test_pycode
~~~~~~~~~~~
Test pycode.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test pycode."""
import os
import sys

View File

@@ -1,12 +1,4 @@
"""
test_pycode_ast
~~~~~~~~~~~~~~~
Test pycode.ast
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test pycode.ast"""
import sys

View File

@@ -1,12 +1,4 @@
"""
test_pycode_parser
~~~~~~~~~~~~~~~~~~
Test pycode.parser.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test pycode.parser."""
from sphinx.pycode.parser import Parser
from sphinx.util.inspect import signature_from_str

View File

@@ -1,12 +1,4 @@
"""
test_quickstart
~~~~~~~~~~~~~~~
Test the sphinx.quickstart module.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the sphinx.quickstart module."""
import time
from io import StringIO

View File

@@ -1,12 +1,4 @@
"""
test_roles
~~~~~~~~~~
Test sphinx.roles
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.roles"""
from unittest.mock import Mock

View File

@@ -1,12 +1,4 @@
"""
test_search
~~~~~~~~~~~
Test the search index builder.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the search index builder."""
from collections import namedtuple
from io import BytesIO

View File

@@ -1,12 +1,4 @@
"""
test_setup_command
~~~~~~~~~~~~~~~~~~~
Test setup_command for distutils.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test setup_command for distutils."""
import os
import subprocess

View File

@@ -1,12 +1,4 @@
"""
test_smartquotes
~~~~~~~~~~~~~~~~
Test smart quotes.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test smart quotes."""
import pytest
from html5lib import HTMLParser

View File

@@ -1,12 +1,4 @@
"""
test_templating
~~~~~~~~~~~~~~~~
Test templating.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test templating."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_theming
~~~~~~~~~~~~
Test the Theme class.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the Theme class."""
import os

View File

@@ -1,12 +1,4 @@
"""
test_toctree
~~~~~~~~~~~~
Test the HTML builder and check output against XPath.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test the HTML builder and check output against XPath."""
import re
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_transforms_post_transforms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Tests the post_transforms
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests the post_transforms"""
import pytest
from docutils import nodes

View File

@@ -1,11 +1,3 @@
"""
test_transforms_post_transforms_code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_util
~~~~~~~~~~~~~~~
Tests util functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests util functions."""
import os
import tempfile

View File

@@ -1,12 +1,4 @@
"""
test_util_docstrings
~~~~~~~~~~~~~~~~~~~~
Test sphinx.util.docstrings.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test sphinx.util.docstrings."""
from sphinx.util.docstrings import prepare_commentdoc, prepare_docstring, separate_metadata

View File

@@ -1,12 +1,4 @@
"""
test_util_docutils
~~~~~~~~~~~~~~~~~~
Tests util.utils functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests util.utils functions."""
import os

View File

@@ -1,12 +1,4 @@
"""
test_util_fileutil
~~~~~~~~~~~~~~~~~~
Tests sphinx.util.fileutil functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests sphinx.util.fileutil functions."""
from unittest import mock

View File

@@ -1,12 +1,4 @@
"""
test_util_i18n
~~~~~~~~~~~~~~
Test i18n util.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test i18n util."""
import datetime
import os

View File

@@ -1,12 +1,4 @@
"""
test_util_images
~~~~~~~~~~~~~~~~
Test images util.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test images util."""
import pytest

View File

@@ -1,12 +1,4 @@
"""
test_util_inspect
~~~~~~~~~~~~~~~
Tests util.inspect functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests util.inspect functions."""
import ast
import datetime

View File

@@ -1,12 +1,4 @@
"""
test_util_inventory
~~~~~~~~~~~~~~~~~~~
Test inventory util functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test inventory util functions."""
import posixpath
import zlib

View File

@@ -1,12 +1,4 @@
"""
test_util_logging
~~~~~~~~~~~~~~~~~
Test logging util.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Test logging util."""
import codecs
import os

View File

@@ -1,12 +1,4 @@
"""
test_util_matching
~~~~~~~~~~~~~~~~~~
Tests sphinx.util.matching functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests sphinx.util.matching functions."""
from sphinx.util.matching import Matcher, compile_matchers

View File

@@ -1,12 +1,4 @@
"""
test_util_nodes
~~~~~~~~~~~~~~~
Tests uti.nodes functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests uti.nodes functions."""
from textwrap import dedent
from typing import Any

View File

@@ -1,12 +1,4 @@
"""
test_util_rst
~~~~~~~~~~~~~~~
Tests sphinx.util.rst functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests sphinx.util.rst functions."""
from docutils.statemachine import StringList
from jinja2 import Environment

View File

@@ -1,12 +1,4 @@
"""
test_util_template
~~~~~~~~~~~~~~~~~~
Tests sphinx.util.template functions.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
"""Tests sphinx.util.template functions."""
from sphinx.util.template import ReSTRenderer

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