autosummary: respect py:currentclass when looking up Python objects

This makes autosummary directives inside classes to work properly.
This commit is contained in:
Pauli Virtanen 2011-06-29 21:27:23 +02:00
parent 9962c00947
commit bb51a20745
2 changed files with 33 additions and 1 deletions

View File

@ -171,7 +171,7 @@ class Autosummary(Directive):
"""
Pretty table containing short signatures and summaries of functions etc.
autosummary also generates a (hidden) toctree:: node.
autosummary can also optionally generate a hidden toctree:: node.
"""
required_arguments = 0
@ -232,10 +232,18 @@ class Autosummary(Directive):
env = self.state.document.settings.env
prefixes = ['']
currmodule = env.temp_data.get('py:module')
if currmodule:
prefixes.insert(0, currmodule)
currclass = env.temp_data.get('py:class')
if currclass:
if currmodule:
prefixes.insert(0, currmodule + "." + currclass)
else:
prefixes.insert(0, currclass)
items = []
max_item_chars = 50

View File

@ -5,3 +5,27 @@ Autosummary test
:toctree: generated
sphinx.application.TemplateBridge
.. 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