Validate homepage has been moved. Please venture to:
https://sphinxcontrib-confluencebuilder.atlassian.net/
devel-autodocs - automodule
This page shows an example of the directive.
This is a module docstring
- class
Hello.
Hello
(name, name2) This is a Hello class docstring
foo
(arg2)A method’s docstring with parameters and return value.
Use all the cool Sphinx capabilities in this description, e.g. to give usage examples …
Example: >>> another_class.foo('', AClass())
Parameters: -
arg1 (string) – first argument
-
arg2 (
module.AClass
) – second argument
Returns: something
Return type: string
Raises: TypeError
-
say_hello
()This is a say_hello method decorator