IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

apidoc: Add `--automodule-options`

Browse Source
This commit is contained in:
Adam Turner
2025-01-07 07:11:53 +00:00
parent 76c4e9173e
commit 47599df1bc
2 changed files with 37 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
tests/test_extensions/test_ext_apidoc.py
View File

@@ -507,8 +507,8 @@ def test_module_file(tmp_path):
'\n'
'.. automodule:: example\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)
@@ -522,8 +522,8 @@ def test_module_file_noheadings(tmp_path):
assert content == (
'.. automodule:: example\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)
@@ -560,24 +560,24 @@ def test_package_file(tmp_path):
'\n'
'.. automodule:: testpkg.hello\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
'\n'
'testpkg.world module\n'
'--------------------\n'
'\n'
'.. automodule:: testpkg.world\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
'\n'
'Module contents\n'
'---------------\n'
'\n'
'.. automodule:: testpkg\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)
content = (outdir / 'testpkg.subpkg.rst').read_text(encoding='utf8')
@@ -590,8 +590,8 @@ def test_package_file(tmp_path):
'\n'
'.. automodule:: testpkg.subpkg\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)
@@ -622,8 +622,8 @@ def test_package_file_separate(tmp_path):
'\n'
'.. automodule:: testpkg\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)
content = (outdir / 'testpkg.example.rst').read_text(encoding='utf8')
@@ -633,8 +633,8 @@ def test_package_file_separate(tmp_path):
'\n'
'.. automodule:: testpkg.example\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)
@@ -652,8 +652,8 @@ def test_package_file_module_first(tmp_path):
'\n'
'.. automodule:: testpkg\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
'\n'
'Submodules\n'
'----------\n'
@@ -663,8 +663,8 @@ def test_package_file_module_first(tmp_path):
'\n'
'.. automodule:: testpkg.example\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)
@@ -685,8 +685,8 @@ def test_package_file_without_submodules(tmp_path):
'\n'
'.. automodule:: testpkg\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)
@@ -717,8 +717,8 @@ def test_namespace_package_file(tmp_path):
'\n'
'.. automodule:: testpkg.example\n'
' :members:\n'
' :undoc-members:\n'
' :show-inheritance:\n'
' :undoc-members:\n'
)