module subproject.myexampleb
¶
Short summary¶
module python3_module_template.subproject.myexampleb
This the documentation of this module (myexampleb).
Classes¶
class |
truncated documentation |
---|---|
This is the documentation for this class. Inherits from |
Functions¶
function |
truncated documentation |
---|---|
Returns the addition of |
Methods¶
method |
truncated documentation |
---|---|
Example of a docstring used by sphinx.ext.napoleon extension. Args: v1 (int): a integer … |
Documentation¶
This the documentation of this module (myexampleb).
-
class
python3_module_template.subproject.myexampleb.
myclassb
(pa)[source]¶ Bases:
python3_module_template.subproject.myexample.myclass
This is the documentation for this class. Inherits from
myclass
. An example on how to share: .- Parameters
pa – first parameter
-
method_napoleon
(v1, v2)[source]¶ Example of a docstring used by sphinx.ext.napoleon extension.
- Parameters
v1 (int) – a integer
v2 (float) – a float
- Returns
the sum
- Return type
float
- Raises
TypeError – for a type mismatch
See google style