module subproject.myexample

Inheritance diagram of project_name.subproject.myexample

Short summary

module project_name.subproject.myexample

This the documentation of this module (myexampleb).

source on GitHub

Classes

class truncated documentation
myclass This is the documentation for this class. example with a sphinx directives It works everywhere in …

Methods

method truncated documentation
__init__ documentation for the constructor
get_value returns the parameter multiplied by a value

Documentation

This the documentation of this module (myexampleb).

source on GitHub

class project_name.subproject.myexample.myclass(pa)[source]

Bases: object

This is the documentation for this class.

example with a sphinx directives

It works everywhere in the documentation.

an example of use

Just for documentation purpose.

m = myclass(0)

The old way:

Example: an old example of use

This only works from the code, not inserted in a RST file. The source documentation is parsed and every such example is collected and placed in a page all_examples.rst (look at the source).

m = myclass(0)

FAQ

How to add a question ?

Just look a this section. Look also FAQ.

Add a label

Look also FAQ.

BLOC

How to add a bloc

Just look a this bloc. Look also FAQ.

An accent, é, to check it is working.

A link to github source: source.

documentation for the constructor

Parameters:pa – first parameter

source on GitHub

__init__(pa)[source]

documentation for the constructor

Parameters:pa – first parameter

source on GitHub

get_value(mul)[source]

returns the parameter multiplied by a value

Parameters:mul – a float
Returns:a float

source on GitHub