sphinx-autodoc-example/src/module/module_class.py

21 lines
376 B
Python

import sys
import os
MODULE_CONST = 1
class Example:
"""This is an example class which uses python docstrings to document itself.
It lives in :module:.
"""
def foo(self, amount):
"""Applies the well known ``foo`` operation to an instance of
:Example:.
:param: amount: How much foo to do.
"""
self.amount = amount