pydoctor(1) API documentation generator for Python


pydoctor [options]


Pydoctor is an API documentation generator that works primarily by static analysis.

It was written primarily to replace epydoc for the purposes of the Twisted project as epydoc has difficulties with zope.interface, but can be used for non-Zope Python code as well.


-h, --help
show this help message and exit
Use config from this file (any command lineoptions override settings from the file).
Load the system from this pickle file (default: none, a blank system is created).
Save the system to this pickle file (default: none, the system is not saved by default).
Look for objects in this system to. Links to these objects will have URLPREFIX prepended to them.
A dotted name of the class to use to make a system.
The project name, appears in the html.
The project url, appears in the html if given.
Absolute path to the base directory of the project. Source links will be computed based on this value.
Don't complain if the run doesn't have any effects.
Like py.test's --pdb.
Produce html output.
Serve HTML on a local server.
The port for --server to use.
Bind the server to localhost only.
Set up a VHostMonster, with all the confusion that implies.
When serving HTML, allow editing.
When serving HTML and allow editing, don't check all docstrings first.
Add a package to the system. Can be repeated to add more than one package.
Add a module to the system. Can be repeated.
Pretend that all packages are within this one. Can be used to document part of a package.
This updates references to classes imported from a module into which they were imported to references to where they are defined.
This is a comma seperated list of key=value pairs. Where any key corresponds to a module name and value is the desired abbreviation. This can be used to resolve conflicts with abbreviation where you have two or more modules that start with the same letter. Example: twistedcaldav=tcd.
Which epydoc-supported format docstrings are assumed to be in.
The fullName of object to generate API docs for (default: everything).
Only generate the summary pages.
Make individual HTML files for every function and method. They're not linked to in any pydoctorgenerated HTML, but they can be useful for third-party linking.
Directory to save HTML files to (default 'apidocs')
Dotted name of html writer class to use (default 'pydoctor.nevowhtml.NevowWriter', requires Divmod Nevow to be installed).
This should be the path to the trac browser for the top of the svn checkout we are documenting part of.
Use the sorttable JS library to make tables of package, module and class contents sortable
Generate (unobstrusive) JavaScript to allow class methods to be shown either in one table per base class or in one big table.
Generate (unobstrusive) JavaScript to hide some of the entries in long lists of e.g. subclasses.
Import and examine the modules too. XXX not working right now
-v, --verbose
Be noisier. Can be repeated for more noise.
-q, --quiet
Be quieter.
Automagic mode: analyze all modules and packages in the current working directory and run a local server that allows examination and editing of the docstrings.
Be noiser during a particular stage of generation.


pydoctor is licensed under the simplified BSD license.


pydoctor was written and is maintained by Michael Hudson.

This manual page was written by Jelmer Vernooij <[email protected]>, for the Debian project (and may be used by others).