Module Index

Classes

Functions

Module: command

Apydia command line tool (and distutils command)

Use the apydia command to generate API reference documentation: 

Usage: apydia [options] [modules]

Apydia API Documentation Generator

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -c CONFIGFILE, --config=CONFIGFILE
                        specify config file
  -d DESTINATION, --destination=DESTINATION
                        specify output directory
  -o, --open            open in browser
  -f FORMAT, --format=FORMAT
                        rendering format (xhtml or html, defaults to xhtml)
  -s THEME, --style=THEME
                        Choose a theme
  -p DOCFORMAT, --parser=DOCFORMAT
                        docstring parser (markdown, textile, restucturedtext,
                        html, ...)
  -b TRAC_BROWSER_URL, --trac-browser-url=TRAC_BROWSER_URL
                        trac browser url (path to root module)
  -q, --quiet           silent mode
  -t TITLE, --title=TITLE
                        title of project
  -x EXCLUDE_MODULES, --exclude-modules=EXCLUDE_MODULES
                        exclude modules

Or run it through distutils by configuring your project's setup.cfg appropriately (see documentation) and issuing from your project root: 

python setup.py apydia

Classes

apydia

The apydia-command as an extension to distutils.

Functions

main ()

Generate api reference documentation from the command line

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 

class CodeExample(object):
    def __init__(self):
        pass

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.