Source code for python3_module_template.subproject.myexample

# -*- coding: utf-8 -*-

"""
This the documentation of this module (myexampleb).


:githublink:`%|py|7`
"""


[docs]class myclass: """ This is the documentation for this class. **example with a sphinx directives** It works everywhere in the documentation. .. exref:: :title: an example of use Just for documentation purpose. :: m = myclass(0) The old way: .. _le-myexample-l87: .. _le-anoldexampleofuse: **Example: an old example of use** .. example(an old example of use;;le-myexample-l87). 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) .. endexample. **FAQ** .. faqref:: :title: How to add a question ? Just look a this section. Look also :ref:`l-FAQ2`. .. faqref:: :title: Add a label :lid: label1 Look also :ref:`l-FAQ2`. **BLOC** .. blocref:: :title: How to add a bloc :tag: aaaa Just look a this bloc. Look also :ref:`l-FAQ2`. An accent, é, to check it is working. A link to github source: :githublink:`source|py`. """
[docs] def __init__(self, pa): """ documentation for the constructor :param pa: first parameter :githublink:`%|py|75` """ self.pa = pa
[docs] def get_value(self, mul): """ returns the parameter multiplied by a value :param mul: a float :return: a float :githublink:`%|py|83` """ return self.pa * mul