example_module module¶
This is an example Python module for the Python to Read the Docs documentation repository.
It is used to show how Sphinx autodoc can be used to auto-generate Python documentation from doc strings like this...
Written by Matthew John Hayes
-
class
example_module.
ExampleModule
¶ Bases:
object
This is the main class of example_module. It doesn’t do anything useful other than show how classes are documented by autodoc
-
increment
(value)¶ Increment the value of self.class_variable by value passed to this method
-
run
()¶ Run the ExampleModule instance
-