mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Responding to comments
This commit is contained in:
parent
4e0ff5cac2
commit
52c173bdb9
@ -1,16 +1,31 @@
|
|||||||
sphinx
|
Autosummary test
|
||||||
======
|
================
|
||||||
|
|
||||||
.. automodule:: sphinx
|
.. autosummary::
|
||||||
|
:toctree: generated
|
||||||
|
|
||||||
|
sphinx.application.Sphinx
|
||||||
|
|
||||||
|
.. currentmodule:: sphinx.application
|
||||||
|
|
||||||
|
.. autoclass:: TemplateBridge
|
||||||
|
|
||||||
|
Basic test
|
||||||
|
|
||||||
|
.. autosummary::
|
||||||
|
|
||||||
|
render -- some ignored stuff goes here
|
||||||
|
render_string More ignored stuff
|
||||||
|
|
||||||
|
Test with tildes
|
||||||
|
|
||||||
|
.. autosummary::
|
||||||
|
|
||||||
|
~TemplateBridge.render
|
||||||
|
~TemplateBridge.render_string
|
||||||
|
|
||||||
|
Methods:
|
||||||
|
|
||||||
|
.. automethod:: render
|
||||||
|
|
||||||
|
.. automethod:: render_string
|
||||||
|
@ -1,4 +0,0 @@
|
|||||||
import sys
|
|
||||||
|
|
||||||
# Fail module import in a catastrophic way
|
|
||||||
sys.exit(1)
|
|
@ -5,6 +5,7 @@ sys.path.insert(0, os.path.abspath('.'))
|
|||||||
|
|
||||||
extensions = ['sphinx.ext.autosummary']
|
extensions = ['sphinx.ext.autosummary']
|
||||||
autosummary_generate = True
|
autosummary_generate = True
|
||||||
|
autosummary_filename_map = {
|
||||||
# The suffix of source filenames.
|
"autosummary_dummy_module": "module_mangled",
|
||||||
source_suffix = '.rst'
|
"autosummary_dummy_module.bar": "bar"
|
||||||
|
}
|
||||||
|
@ -12,4 +12,3 @@
|
|||||||
autosummary_dummy_module.Foo.Bar
|
autosummary_dummy_module.Foo.Bar
|
||||||
autosummary_dummy_module.bar
|
autosummary_dummy_module.bar
|
||||||
autosummary_dummy_module.qux
|
autosummary_dummy_module.qux
|
||||||
autosummary_importfail
|
|
||||||
|
@ -386,10 +386,7 @@ def test_autosummary_recursive(app, status, warning):
|
|||||||
assert 'package.package.module' in content
|
assert 'package.package.module' in content
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.sphinx('dummy', testroot='ext-autosummary-filename-map',
|
@pytest.mark.sphinx('dummy', testroot='ext-autosummary-filename-map')
|
||||||
confoverrides={'autosummary_filename_map':
|
|
||||||
{"autosummary_dummy_module": "module_mangled",
|
|
||||||
"autosummary_dummy_module.bar": "bar"}})
|
|
||||||
def test_autosummary_filename_map(app, status, warning):
|
def test_autosummary_filename_map(app, status, warning):
|
||||||
app.build()
|
app.build()
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user