Auto Generated Documentation

main.py

The core module of my example project

class main.ExampleClass(name)

Bases: object

An example docstring for a class definition.

about_self()

Return information about an instance created from ExampleClass.

main.about_me(your_name)

Return the most important thing about a person.

Parameters:your_name – A string indicating the name of the person.