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. Not as pretty as either. But it works, it's small, and the output looks like the pydoc you remember from 2003 (now with themes).

Requires Python 3.10+

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

# 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

# Pick a theme and label the project
pydoc_fork my_module --output docs --theme dark --project_name "My Cool Lib"

# Link to docs.python.org for stdlib references instead of regenerating them
pydoc_fork my_module --output docs --prefer_docs_python_org

# Skip the index.html (e.g. you have your own landing page)
pydoc_fork my_module --output docs --no_index

# Use a pyproject.toml for configuration (see "Config" below)
pydoc_fork my_module --output docs --config .

# Launch the (extremely minimal) Tk GUI
pydoc gui

Run pydoc_fork --help for the full list of flags.

Anything you can pass on the command line you can also stash under [tool.pydoc_fork] in a pyproject.toml and point at it with --config <dir>:

[tool.pydoc_fork]
PROJECT_NAME = "My Cool Lib"
THEME = "dark"
DOCUMENT_INTERNALS = true
PREFER_DOCS_PYTHON_ORG = true
GENERATE_INDEX = true
SKIP_MODULES = ["typing"]
# CUSTOM_TEMPLATES = "./my_templates"  # optional, see below

Three themes ship in the box. They are CSS variables on a :root block, so if you want to tweak one, fork pydoc_fork/reporter/themes.py — it's a single dict.

pydoc_fork my_module --output docs --theme light

Output is rendered through Jinja2 templates that live in pydoc_fork/templates/:

class.jinja2          function.jinja2    module.jinja2
data.jinja2           heading.jinja2     multicolumn.jinja2
disabled_text.jinja2  index.jinja2       page.jinja2
fallback.jinja2       section.jinja2

If you want to change the layout, copy that folder somewhere, edit, and point CUSTOM_TEMPLATES at it in your pyproject.toml. (The plumbing for swapping the Jinja loader is in pydoc_fork/reporter/jinja_code.py — keep it minimal.)

A compact workflow that generates docs into ./site on every push to main and publishes them. Drop it at .github/workflows/docs.yml:

name: docs
on:
  push:
    branches: [main]
permissions:
  contents: read
  pages: write
  id-token: write
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deploy.outputs.page_url }}
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with: { python-version: "3.12" }
      - run: pip install . pydoc_fork
      - run: pydoc_fork my_module --output site --theme light --project_name "My Cool Lib"
      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with: { path: site }
      - id: deploy
        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1

One-time setup: in your repo, Settings → Pages → Build and deployment → Source: GitHub Actions. After the first successful run the URL will appear at the top of the Pages settings panel and in the workflow summary.

• Motivation
• Prior Art
• TODO

Because the best way to evaluate a doc generator is to see it run on the same codebase as its peers:

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

pydoc_fork exists because none of these were quite the right shape for "generate API HTML on a build server and forget about it." They are all, however, excellent at what they do — try them first.

• pydoc — the stdlib original. The direct ancestor of this fork. Great for pydoc -p 0 at a REPL; awkward for "render all of my package to a folder of HTML in CI."
• pdoc3 / pdoc — the closest peers. Nicer output, more features, more configuration surface. If you want the output to look modern out of the box, start here.
• Sphinx — the heavyweight. Unmatched for narrative documentation, cross-references, and multi-format output. Has a learning curve, a conf.py, an index.rst, themes, extensions, and opinions. Worth it for large projects.
• MkDocs + mkdocstrings — Markdown-first sites with API docs injected via ::: module.name. Lovely output (especially with the Material theme), but it is a site generator first and an API extractor second.
• pdocs / portray — Timothy Crosley's duo. Portray is "MkDocs + pdocs + zero config" — very nice if your project fits the mold.
• PyDoctor — the original API doc tool for Twisted. Strict about docstring formatting, produces dense reference output.
• Pycco — literate-style side-by-side source/docs. Different goal, but worth knowing about.
• Doxygen — yes, it does Python. No, you probably don't want it for Python.
• Read the Docs — not a generator but a hosting platform; pairs with Sphinx or MkDocs. The "obvious" alternative to the GitHub Pages workflow above.

If you are starting a new project and want something modern with a thriving community, pick pdoc or mkdocstrings. If you want output that screams "this is the API and nothing else, rendered the way pydoc has always rendered it" and you want to call it from a one-line shell script in CI, this fork is for you.

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.

• GitHub
• PyPI
• Documentation
• Bug Tracker
• Change Log