py_qs_example.mypackage package

An example docstring for the mypackage package.

Describe what the entire package is for, with the first sentence containing the main idea.

Submodules

py_qs_example.mypackage.module module

An example docstring for the mypackage.module module.

Describe what the entire module is for, with the first sentence containing the main idea.

class py_qs_example.mypackage.module.ExampleClass2(num, klass)

Bases: object

An example class created from the pypi-sphinx-quickstart tutorial.

__init__(num, klass)

Class init method.

Describe how to pass arguments here.

Parameters

• num (int) – example argument with builtin type

• klass (ExampleClass2) – example argument with custom type

do_something(arg)

Class method that does something.

Describe it here.

Parameters

arg (str) – Example argument with builtin type

Return type

str

Returns

A return value

py_qs_example.mypackage.module.example_function2(thing, arg)

Example for function documentation.

Parameters

• thing (ExampleClass2) – A thing to pass

• arg (str) – another thing to pass

Return type

str

Returns

thing and arg combined into a string