module subproject2.myexample2

Short summary

module python3_module_template.subproject2.myexample2

This the documentation of this module (myexample2).

To make a reference to a blog post, just read 2016-06-11 Make a reference to a blog post.

The following documentation comes from a directive runpython which outputs documentation on the standard output:

.. runpython::
    :showcode:

    for l in range(0,10):
        print("    line", l)

Which gives:

Classes

class	truncated documentation
myclass2	This is the documentation for this class.

Properties

property	truncated documentation
property_example	a property example

Static Methods

staticmethod	truncated documentation
static_example

Methods

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

Documentation

This the documentation of this module (myexample2).

To make a reference to a blog post, just read 2016-06-11 Make a reference to a blog post.

The following documentation comes from a directive runpython which outputs documentation on the standard output:

.. runpython::
    :showcode:

    for l in range(0,10):
        print("    line", l)

Which gives:

<<<

for l in range(0, 10):
    print("    line", l)

>>>

        line 0
        line 1
        line 2
        line 3
        line 4
        line 5
        line 6
        line 7
        line 8
        line 9

And without the input code:

        line 0
        line 1
        line 2
        line 3
        line 4
        line 5
        line 6
        line 7
        line 8
        line 9

You can also add option rst:

.. runpython::
    :rst:

    for l in range(0,10):
        print("**line**", "*" +str(l)+"*")
        print('')

Which displays interpreted RST:

line 0

line 1

line 2

line 3

line 4

line 5

line 6

line 7

line 8

line 9

It can be run in a separate process with option :process: (click on source):

    __init__.py

source on GitHub

class python3_module_template.subproject2.myexample2.myclass2(pa)

Bases: myclass

This is the documentation for this class.

attribute	meaning
pa	an example of an attribute.

Inline . Another equation to test:

source on GitHub

Parameters:

pa – first parameter

source on GitHub

__init__(pa)

Parameters:

pa – first parameter

source on GitHub

get_value(mul)

returns the parameter multiplied by a value

Parameters:

mul – a float

Returns:

a float

source on GitHub

property property_example

a property example

source on GitHub

static static_example()

Returns:

a boolean

source on GitHub