mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
0d7451c23d
A common use case for this is a class like `namedtuple`, which has a public `_replace` method that is so-named in order not to conflict with arbitrary user-provided attributes. Rejected spellings include: * `:meta not-private:` * `:meta private: False`
63 lines
1.6 KiB
Python
63 lines
1.6 KiB
Python
"""
|
|
test_ext_autodoc_private_members
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Test the autodoc extension. This tests mainly for private-members option.
|
|
|
|
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import pytest
|
|
|
|
from test_autodoc import do_autodoc
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
|
def test_private_field(app):
|
|
app.config.autoclass_content = 'class'
|
|
options = {"members": None}
|
|
actual = do_autodoc(app, 'module', 'target.private', options)
|
|
assert list(actual) == [
|
|
'',
|
|
'.. py:module:: target.private',
|
|
'',
|
|
'',
|
|
'.. py:function:: _public_function(name)',
|
|
' :module: target.private',
|
|
'',
|
|
' public_function is a docstring().',
|
|
'',
|
|
' :meta public:',
|
|
'',
|
|
]
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='ext-autodoc')
|
|
def test_private_field_and_private_members(app):
|
|
app.config.autoclass_content = 'class'
|
|
options = {"members": None,
|
|
"private-members": None}
|
|
actual = do_autodoc(app, 'module', 'target.private', options)
|
|
assert list(actual) == [
|
|
'',
|
|
'.. py:module:: target.private',
|
|
'',
|
|
'',
|
|
'.. py:function:: _public_function(name)',
|
|
' :module: target.private',
|
|
'',
|
|
' public_function is a docstring().',
|
|
'',
|
|
' :meta public:',
|
|
'',
|
|
'',
|
|
'.. py:function:: private_function(name)',
|
|
' :module: target.private',
|
|
'',
|
|
' private_function is a docstring().',
|
|
'',
|
|
' :meta private:',
|
|
'',
|
|
]
|