pdocs 1.0.0

Read Latest Documentation - Browse GitHub Code Repository

pdocs is a library and a command line program to discover the public interface of a Python module or package. The pdocs script can be used to generate Markdown or HTML of a module's public interface, or it can be used to run an HTTP server that serves generated HTML for installed modules.

pdocs is an MIT Licensed fork of pdoc with the goal of staying true to the original vision layed out by the projects creator.

NOTE: For most projects, the best way to use pdocs is using portray.

Features

• Support for documenting data representation by traversing the abstract syntax to find docstrings for module, class and instance variables.
• For cases where docstrings aren't appropriate (like a namedtuple), the special variable __pdocs__ can be used in your module to document any identifier in your public interface.
• Usage is simple. Just write your documentation as Markdown. There are no added special syntax rules.
• pdocs respects your __all__ variable when present.
• pdocs will automatically link identifiers in your docstrings to its corresponding documentation.
• When pdocs is run as an HTTP server, external linking is supported between packages.
• The pdocs HTTP server will cache generated documentation and automatically regenerate it if the source code has been updated.
• When available, source code for modules, functions and classes can be viewed in the HTML documentation.
• Inheritance is used when possible to infer docstrings for class members.

The above features are explained in more detail in pdocs's documentation.

pdocs is compatible with Python 3.6 and newer.