Examples

This directory contains some pdoc template examples:

• custom-template: Showcasing various template configuration options.
• dark-mode: Style pdoc with a dark theme.
• library-usage: Using pdoc as a Python library.
• mkdocs: Integrate pdoc with mkdocs.

Third-Party Examples

• Hugo Integration:
  • Final Result: https://docs.mitmproxy.org/stable/api/events.html
  • Template: https://github.com/mitmproxy/mitmproxy/tree/main/docs/scripts/pdoc-template
  • Generation: https://github.com/mitmproxy/mitmproxy/blob/main/docs/scripts/api-render.py

If you have a good example of embedding pdoc into a particular CMS/static site generator, please add it here!