py_qs_example package

An example package created by pypi-sphinx-quickstart.

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

Subpackages

• py_qs_example.mypackage package
  • Submodules
  • py_qs_example.mypackage.module module

Submodules

py_qs_example.mymodule module

An example docstring for the mymodule module.

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

class py_qs_example.mymodule.ExampleClass(num, klass=None)

Bases: object

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

__init__(num, klass=None)

Class init method.

Describe how to pass arguments here.

Parameters

• num (int) – example argument with builtin type

• klass (Optional[ExampleClass]) – example argument with custom type

do_something(arg)

Class method that does something.

Describe it here.

Parameters

arg (str) – A thing to pass

Return type

str

Returns

A return value

Example

>>> import py_qs_example.mymodule
>>> ec = py_qs_example.mymodule.ExampleClass(1)
>>> ec.do_something('this')
'this'

py_qs_example.mymodule.example_function(thing, arg)

Example for function documentation.

Parameters

• thing (ExampleClass) – A thing to pass

• arg (str) – another thing to pass

Return type

str

Returns

thing and arg combined into a string

Example

>>> import py_qs_example.mymodule
>>> ec = py_qs_example.mymodule.ExampleClass(1)
>>> py_qs_example.mymodule.example_function(ec, 'this')
'examplethis'

py_qs_example.mymodule.less_important_function(num)

Example which is documented in the module documentation but not highlighted on the main page.

Parameters

num (int) – A thing to pass

Return type

str

Returns

A return value