pyfoobar (Python module)

pyfoobar: Python Module for testing read the docs

Author: H. U.R. Strand (2017)

class pyfoobar.MyClass(name)[source]

This is a test class with some doc strings.

Extended description of the class

Todo

Write more documentation!

Notes

Needs more testing!

__init__(name)[source]

Here we construct the MyClass object

Parameters

name ((str)) – The name of the MyClass instance.

do_stuff()[source]

This is not a default method that actually does something

do_stuff_with_args(A, B)[source]

This is a method that takes arguments

Longer description of the function…

Parameters

  • A (int) – Description of A

  • B (float) – Description of B

Returns

The sum of A and B

Return type

int

math_docstring()[source]

Here we test the sphinx based math features \(\alpha+\beta+\gamma\)

\[\int_0^\beta d\tau e^{-i\nu_n \tau} G(\tau) = G(i\nu_n)\]

Do we have to indent the math along the method?

no_doc_string()[source]