PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Edward Loper's API Documentation Generation Tool

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for edloper from gravatar.com edloper

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (IBM Open Source License)
  • Author: Edward Loper
  • Tags docstring, restructuredtext, rst, javadoc, docformat, pydoc, epydoc
Classifiers

Project description

Epydoc is a tool for generating API documentation documentation for Python modules, based on their docstrings. For an example of epydoc’s output, see the API documentation for epydoc itself (html, pdf). A lightweight markup language called epytext can be used to format docstrings, and to add information about specific fields, such as parameters and instance variables. Epydoc also understands docstrings written in reStructuredText, Javadoc, and plaintext. For a more extensive example of epydoc’s output, see the API documentation for Python 2.5.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page