File: README.md

package info (click to toggle)
python-pdoc 15.0.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,192 kB
  • sloc: python: 8,013; javascript: 1,156; makefile: 18; sh: 3
file content (17 lines) | stat: -rw-r--r-- 692 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 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!