example_module2 module

This is a second example Python module for the Python to Read the Docs documentation repository.

It is used to show how Read the Docs can be configured to install dependant modules so that Sphinx autodoc can run

Written by Matthew John Hayes

class example_module2.ExampleModule2

Bases: object

This is the main class of example_module2

__dict__ = dict_proxy({'__module__': 'example_module2', '_private_method': <function _private_method>, 'run': <function run>, 'increment': <function increment>, '__dict__': <attribute '__dict__' of 'ExampleModule2' objects>, '__weakref__': <attribute '__weakref__' of 'ExampleModule2' objects>, '__doc__': '\n This is the main class of example_module2\n ', '__init__': <function __init__>})

__init__()

Initialise the ExampleModule2 class

__module__ = 'example_module2'

__weakref__

list of weak references to the object (if defined)

_private_method()

Example private method that won’t be documented by autodoc unless you add :private-members: to the automodule directive

increment(value)

Increment the value of self.class_variable by value passed to this method

run()

Run the ExampleModule2 instance