mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
5676fdeb4e
According to the existing options of autodoc directives, `:novalue:` option is now renamed to `:no-value:` option.
42 lines
1.1 KiB
Python
42 lines
1.1 KiB
Python
"""
|
|
test_ext_autodoc_autodata
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
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-2020 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import pytest
|
|
from test_ext_autodoc import do_autodoc
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
|
def test_autodata(app):
|
|
actual = do_autodoc(app, 'data', 'target.integer')
|
|
assert list(actual) == [
|
|
'',
|
|
'.. py:data:: integer',
|
|
' :module: target',
|
|
' :value: 1',
|
|
'',
|
|
' documentation for the integer',
|
|
'',
|
|
]
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
|
def test_autodata_novalue(app):
|
|
options = {'no-value': True}
|
|
actual = do_autodoc(app, 'data', 'target.integer', options)
|
|
assert list(actual) == [
|
|
'',
|
|
'.. py:data:: integer',
|
|
' :module: target',
|
|
'',
|
|
' documentation for the integer',
|
|
'',
|
|
]
|