v1.2-autodocs

This page shows an example of various autodoc capabilities.

autodocs - automodule

The automodule directive:

This is a module docstring

class Hello.Hello(name, name2)

This is a Hello class docstring

foo(arg1, 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

---

The autoclass directive:

class Hello.Hello(name, name2)

This is a Hello class docstring

foo(arg1, arg2)

An overwritten description of the method foo.

say_hello()

This is a say_hello method decorator

---

The autofunction directive:

func.my_custom_function(obj)

A function’s docstring with a parameter.

Parameters:

obj – the function argument