19. Autodoc tests
Just testing a few autodoc possibilities...
19.1. Sphinx test suite utilities
| copyright: | Copyright 2007-2016 by the Sphinx team, see AUTHORS. |
|---|---|
| license: | BSD, see LICENSE for details. |
19.2. test_autodoc
Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build.
| copyright: | Copyright 2007-2016 by the Sphinx team, see AUTHORS. |
|---|---|
| license: | BSD, see LICENSE for details. |
-
class
test_autodoc.Class(arg) Class to document.
-
attr= 'bar' should be documented – süß
-
descr Descriptor instance docstring.
-
docattr= 'baz' should likewise be documented – süß
-
excludemeth() Method that should be excluded.
-
inst_attr_comment= None a documented instance attribute
-
inst_attr_inline= None an inline documented instance attr
-
inst_attr_string= None a documented instance attribute
-
mdocattr= <StringIO.StringIO instance> should be documented as well - süß
-
meth() Function.
-
classmethod
moore(a, e, f) → happiness
-
prop Property.
-
skipmeth() Method that should be skipped.
-
udocattr= 'quux' should be documented as well - süß
-
-
test_autodoc.function(foo, *args, **kwds) Return spam.
-
class
test_autodoc.Class(arg) Class to document.
Additional content.
-
attr= 'bar' should be documented – süß
-
descr Descriptor instance docstring.
-
docattr= 'baz' should likewise be documented – süß
-
excludemeth() Method that should be excluded.
-
inheritedmeth() Inherited function.
-
inst_attr_comment= None a documented instance attribute
-
inst_attr_inline= None an inline documented instance attr
-
inst_attr_string= None a documented instance attribute
-
mdocattr= <StringIO.StringIO instance> should be documented as well - süß
-
meth() Function.
-
classmethod
moore(a, e, f) → happiness
-
prop Property.
-
skipmeth() Method that should be skipped.
-
udocattr= 'quux' should be documented as well - süß
-
-
class
test_autodoc.Outer Foo
-
class
Inner Foo
-
meth() Foo
-
-
class
-
Class.docattr= 'baz' should likewise be documented – süß
-
exception
test_autodoc.CustomEx My custom exception.
-
f() Exception method.
-
-
class
test_autodoc.CustomDict Bases:
dictDocstring.
-
class
autodoc_fodder.MarkupError Note
This is a docstring with a
small markup error which should have correct location information.
-
class
test_autodoc.InstAttCls Class with documented class and instance attributes.
All members (5 total)
-
ca1= 'a' Doc comment for class attribute InstAttCls.ca1. It can have multiple lines.
-
ca2= 'b' Doc comment for InstAttCls.ca2. One line only.
-
ca3= 'c' Docstring for class attribute InstAttCls.ca3.
-
ia1= None Doc comment for instance attribute InstAttCls.ia1
-
ia2= None Docstring for instance attribute InstAttCls.ia2.
-
-
class
test_autodoc.InstAttCls Class with documented class and instance attributes.
Specific members (2 total)
-
ca1= 'a' Doc comment for class attribute InstAttCls.ca1. It can have multiple lines.
-
ia1= None Doc comment for instance attribute InstAttCls.ia1
-