mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
test: Move testcases for autodoc events to test_ext_autodoc_events
This commit is contained in:
parent
7de8c63407
commit
c8554e7673
@ -16,7 +16,7 @@ from warnings import catch_warnings
|
|||||||
import pytest
|
import pytest
|
||||||
from docutils.statemachine import ViewList
|
from docutils.statemachine import ViewList
|
||||||
|
|
||||||
from sphinx.ext.autodoc import ModuleLevelDocumenter, cut_lines, between, ALL, Options
|
from sphinx.ext.autodoc import ModuleLevelDocumenter, ALL, Options
|
||||||
from sphinx.ext.autodoc.directive import DocumenterBridge, process_documenter_options
|
from sphinx.ext.autodoc.directive import DocumenterBridge, process_documenter_options
|
||||||
from sphinx.testing.util import SphinxTestApp, Struct # NOQA
|
from sphinx.testing.util import SphinxTestApp, Struct # NOQA
|
||||||
from sphinx.util import logging
|
from sphinx.util import logging
|
||||||
@ -464,73 +464,6 @@ def test_get_doc():
|
|||||||
assert getdocl('method', Derived.inheritedmeth) == ['Inherited function.']
|
assert getdocl('method', Derived.inheritedmeth) == ['Inherited function.']
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
|
||||||
def test_process_docstring(app):
|
|
||||||
def on_process_docstring(app, what, name, obj, options, lines):
|
|
||||||
lines.clear()
|
|
||||||
lines.append('my docstring')
|
|
||||||
|
|
||||||
app.connect('autodoc-process-docstring', on_process_docstring)
|
|
||||||
|
|
||||||
actual = do_autodoc(app, 'function', 'target.process_docstring.func')
|
|
||||||
assert list(actual) == [
|
|
||||||
'',
|
|
||||||
'.. py:function:: func()',
|
|
||||||
' :module: target.process_docstring',
|
|
||||||
'',
|
|
||||||
' my docstring'
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
|
||||||
def test_cut_lines(app):
|
|
||||||
app.connect('autodoc-process-docstring',
|
|
||||||
cut_lines(2, 2, ['function']))
|
|
||||||
|
|
||||||
actual = do_autodoc(app, 'function', 'target.process_docstring.func')
|
|
||||||
assert list(actual) == [
|
|
||||||
'',
|
|
||||||
'.. py:function:: func()',
|
|
||||||
' :module: target.process_docstring',
|
|
||||||
'',
|
|
||||||
' second line',
|
|
||||||
' '
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
|
||||||
def test_between(app):
|
|
||||||
app.connect('autodoc-process-docstring',
|
|
||||||
between('---', ['function']))
|
|
||||||
|
|
||||||
actual = do_autodoc(app, 'function', 'target.process_docstring.func')
|
|
||||||
assert list(actual) == [
|
|
||||||
'',
|
|
||||||
'.. py:function:: func()',
|
|
||||||
' :module: target.process_docstring',
|
|
||||||
'',
|
|
||||||
' second line',
|
|
||||||
' '
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
|
||||||
def test_between_exclude(app):
|
|
||||||
app.connect('autodoc-process-docstring',
|
|
||||||
between('---', ['function'], exclude=True))
|
|
||||||
|
|
||||||
actual = do_autodoc(app, 'function', 'target.process_docstring.func')
|
|
||||||
assert list(actual) == [
|
|
||||||
'',
|
|
||||||
'.. py:function:: func()',
|
|
||||||
' :module: target.process_docstring',
|
|
||||||
'',
|
|
||||||
' first line',
|
|
||||||
' third line',
|
|
||||||
' '
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
||||||
def test_new_documenter(app):
|
def test_new_documenter(app):
|
||||||
class MyDocumenter(ModuleLevelDocumenter):
|
class MyDocumenter(ModuleLevelDocumenter):
|
||||||
|
81
tests/test_ext_autodoc_events.py
Normal file
81
tests/test_ext_autodoc_events.py
Normal file
@ -0,0 +1,81 @@
|
|||||||
|
"""
|
||||||
|
test_ext_autodoc_events
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Test the autodoc extension. This tests mainly for autodoc events
|
||||||
|
|
||||||
|
:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
|
:license: BSD, see LICENSE for details.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from sphinx.ext.autodoc import between, cut_lines
|
||||||
|
from test_autodoc import do_autodoc
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
||||||
|
def test_process_docstring(app):
|
||||||
|
def on_process_docstring(app, what, name, obj, options, lines):
|
||||||
|
lines.clear()
|
||||||
|
lines.append('my docstring')
|
||||||
|
|
||||||
|
app.connect('autodoc-process-docstring', on_process_docstring)
|
||||||
|
|
||||||
|
actual = do_autodoc(app, 'function', 'target.process_docstring.func')
|
||||||
|
assert list(actual) == [
|
||||||
|
'',
|
||||||
|
'.. py:function:: func()',
|
||||||
|
' :module: target.process_docstring',
|
||||||
|
'',
|
||||||
|
' my docstring'
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
||||||
|
def test_cut_lines(app):
|
||||||
|
app.connect('autodoc-process-docstring',
|
||||||
|
cut_lines(2, 2, ['function']))
|
||||||
|
|
||||||
|
actual = do_autodoc(app, 'function', 'target.process_docstring.func')
|
||||||
|
assert list(actual) == [
|
||||||
|
'',
|
||||||
|
'.. py:function:: func()',
|
||||||
|
' :module: target.process_docstring',
|
||||||
|
'',
|
||||||
|
' second line',
|
||||||
|
' '
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
||||||
|
def test_between(app):
|
||||||
|
app.connect('autodoc-process-docstring',
|
||||||
|
between('---', ['function']))
|
||||||
|
|
||||||
|
actual = do_autodoc(app, 'function', 'target.process_docstring.func')
|
||||||
|
assert list(actual) == [
|
||||||
|
'',
|
||||||
|
'.. py:function:: func()',
|
||||||
|
' :module: target.process_docstring',
|
||||||
|
'',
|
||||||
|
' second line',
|
||||||
|
' '
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
||||||
|
def test_between_exclude(app):
|
||||||
|
app.connect('autodoc-process-docstring',
|
||||||
|
between('---', ['function'], exclude=True))
|
||||||
|
|
||||||
|
actual = do_autodoc(app, 'function', 'target.process_docstring.func')
|
||||||
|
assert list(actual) == [
|
||||||
|
'',
|
||||||
|
'.. py:function:: func()',
|
||||||
|
' :module: target.process_docstring',
|
||||||
|
'',
|
||||||
|
' first line',
|
||||||
|
' third line',
|
||||||
|
' '
|
||||||
|
]
|
Loading…
Reference in New Issue
Block a user