epydoc

tool for documenting Python modules

Install

All systems
curl cmd.cat/epydoc.sh
Debian Debian
apt-get install python-epydoc
Ubuntu
apt-get install python-epydoc
Arch Arch Linux
pacman -S epydoc
image/svg+xml Kali Linux
apt-get install python-epydoc
CentOS
yum install epydoc
Fedora
dnf install epydoc
Windows (WSL2)
sudo apt-get update sudo apt-get install python-epydoc
Raspbian
apt-get install python-epydoc

python-epydoc

tool for documenting Python modules

Epydoc is a tool for generating API documentation for Python modules based on their docstrings. 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. This package contains the epydoc and epydocgui commands, their manpages, and their associated Python modules. Epydoc supports two output formatters: HTML and LaTeX. You must install the suggested dependencies in order to generate documentation in DVI, PostScript, or PDF format using the LaTeX formatter.

epydoc

Tool for generating API documentation for Python modules, based on their docstrings