mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Add more stuff to the autodoc test document, and fix two bugs.
This commit is contained in:
@@ -612,9 +612,9 @@ class ModuleDocumenter(Documenter):
|
|||||||
else:
|
else:
|
||||||
memberlist = self.object.__all__
|
memberlist = self.object.__all__
|
||||||
else:
|
else:
|
||||||
memberlist = self.options.members
|
memberlist = self.options.members or []
|
||||||
ret = []
|
ret = []
|
||||||
for mname in memberlist or ():
|
for mname in memberlist:
|
||||||
try:
|
try:
|
||||||
ret.append((mname, getattr(self.object, mname)))
|
ret.append((mname, getattr(self.object, mname)))
|
||||||
except AttributeError:
|
except AttributeError:
|
||||||
@@ -716,7 +716,8 @@ class ClassDocumenter(ModuleLevelDocumenter):
|
|||||||
ret = ModuleLevelDocumenter.import_object(self)
|
ret = ModuleLevelDocumenter.import_object(self)
|
||||||
# if the class is documented under another name, document it
|
# if the class is documented under another name, document it
|
||||||
# as data/attribute
|
# as data/attribute
|
||||||
self.doc_as_attr = (self.objpath[-1] != self.object.__name__)
|
if ret:
|
||||||
|
self.doc_as_attr = (self.objpath[-1] != self.object.__name__)
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
def format_args(self):
|
def format_args(self):
|
||||||
|
|||||||
@@ -1,7 +1,28 @@
|
|||||||
Autodoc tests
|
Autodoc tests
|
||||||
=============
|
=============
|
||||||
|
|
||||||
|
Just testing a few autodoc possibilities...
|
||||||
|
|
||||||
|
.. automodule:: util
|
||||||
|
|
||||||
.. automodule:: test_autodoc
|
.. automodule:: test_autodoc
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. autofunction:: function
|
.. autofunction:: function
|
||||||
|
|
||||||
|
.. autoclass:: Class
|
||||||
|
:inherited-members:
|
||||||
|
|
||||||
|
Additional content.
|
||||||
|
|
||||||
|
.. autoclass:: Outer
|
||||||
|
:members: Inner
|
||||||
|
|
||||||
|
.. autoattribute:: Class.docattr
|
||||||
|
|
||||||
|
.. autoexception:: CustomEx
|
||||||
|
:members: f
|
||||||
|
|
||||||
|
.. autoclass:: CustomDict
|
||||||
|
:show-inheritance:
|
||||||
|
:members:
|
||||||
|
|||||||
Reference in New Issue
Block a user