Skip to content

Commit

Permalink
test: rename test_cautodoc.py -> test_extension.py
Browse files Browse the repository at this point in the history
cautodoc is a remnant from the past. This module tests the extension,
name it accordingly.

Also rename the test methods to reflect the same.
  • Loading branch information
jnikula committed Sep 15, 2024
1 parent 8ad4aa4 commit 204178f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions test/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ There are three test files, with different levels and approaches, run by
Test the parser and the command-line interface. The documentation comments are
extracted through the command-line interface.

* ``test_directive_text()`` and ``test_directive_html()`` in
``test_cautodoc.py``
* ``test_extension_text()`` and ``test_extension_html()`` in
``test_extension.py``

Test the parser and the Sphinx extension, using two builders: text and
html. The documentation comments are extracted through the Sphinx build
Expand Down
4 changes: 2 additions & 2 deletions test/test_cautodoc.py → test/test_extension.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,12 @@ def _get_extension_testcases(path, buildername):
# Test using Sphinx plain text builder
@pytest.mark.parametrize('testcase', _get_extension_testcases(testenv.testdir, 'text'),
ids=testenv.get_testid)
def test_directive_text(testcase):
def test_extension_text(testcase):
testcase.run_test()

# Test using Sphinx html builder
@pytest.mark.full
@pytest.mark.parametrize('testcase', _get_extension_testcases(testenv.testdir, 'html'),
ids=testenv.get_testid)
def test_directive_html(testcase):
def test_extension_html(testcase):
testcase.run_test()

0 comments on commit 204178f

Please sign in to comment.