matthewdeanmartin / pydoc_fork

Run pydoc on a build server to generate API docs

pydoc_fork

A fork of pydoc to optimize it for generating, on a build server, html documentation for a python library you wrote

Less ambitious than the very good pdoc3 and easier to use than Sphinx

Installation

Requires Python 3.8+

pip install pydoc_fork

# or virtual environment access
pipenv install pydoc_fork

# WARNING- installation by pipx will only allow for doc generation of the python standard library!
pipx install pydoc_fork

Usage

# Generate HTML for all modules and submodules from source code
pydoc_fork my_module --output docs --document_internals

# Generate HTML for a module that is importable, e.g. sys
pydoc_fork sys --output docs

Docs

• Motivation
• Prior Art
• TODO

pydoc_fork documented in several ways:

• pydoc_fork
• Pycco
• PyDoctor
• pdoc3
• mkdocstrings
• sphinx

Credits

Forked from pydoc in python 3.10.

That code is governed by the cpython license

I picked a MIT license, but I'm no lawyer, the cpython license probably governs in any conflict.