Doc de modules python

Les docs peuvent inclure des diagrammes d’héritage (module inheritance_diagram, qui utilise dot).

sample_module.mod1

Sample module just to illustrate doc

class sample_module.mod1.Class1

A class which does nothing.

a_method(a, b, c=0)

Adds arguments

Parameters

• a (float) – 1st argument

• b (float) – 2nd argument

• c (float) – 3rd argument

Returns

sum – the sum

Return type

float

process1

class sample_module.capsul.process1.Process1(**kwargs)

This silly process concatenates in an output file the input file and the other int input parameter. Not very useful, for sure.

Note

• Type ‘Process1.help()’ for a full description of this process parameters.

• Type ‘<Process1>.get_input_spec()’ for a full description of this process input trait types.

• Type ‘<Process1>.get_output_spec()’ for a full description of this process output trait types.

pipeline1

class sample_module.capsul.pipeline1.Pipeline1(autoexport_nodes_parameters=None, **kwargs)

A dumy pipeline example. Contains 3 nodes and a switch.

Note

• Type ‘Pipeline1.help()’ for a full description of this process parameters.

• Type ‘<Pipeline1>.get_input_spec()’ for a full description of this process input trait types.

• Type ‘<Pipeline1>.get_output_spec()’ for a full description of this process output trait types.

pipeline_definition()

Define pipeline structure, nodes, sub-pipelines, switches, and links.

This method should be overloaded in subclasses, it does nothing in the base Pipeline class.