Modules

Summary

module truncated documentation
__init__ module project_name Documentation for this file. source on GitHub
exclude_from_code_coverage module project_name.subproject2.exclude_from_code_coverage This file is excluded from the code coverage while running unit test. See setup.py to see how to configurate this option. source on GitHub
myexample module project_name.subproject.myexample This the documentation of this module (myexampleb). source on GitHub
myexample2 module project_name.subproject2.myexample2 This the documentation of this module (myexample2). To make a reference to a blog post, just read 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: .. runpython:: :showcode: for l in range(0,10): print(” line”, l) And without the input code: .. runpython:: for l in range(0,10): print(” line”, l) You can also add option rst:: .. runpython:: :rst: for l in range(0,10): print(“line”, “*” +str(l)+”*”) print(”) Which displays interpreted RST: .. runpython:: :rst: for l in range(0,10): print(“line”, “*” +str(l)+”*”) print(”) It can be run in a separate process with option :process: (click on source): .. runpython:: :process: import project_name import os print(os.path.split(project_name.__file__)[-1]) source on GitHub
myexampleb module project_name.subproject.myexampleb This the documentation of this module (myexampleb). source on GitHub