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 (15 lines) | stat: -rw-r--r-- 570 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Using a Custom Template

This is an example showing how one can customize pdoc's default template.  
The individual changes are explained in the template files themselves.

To use a custom template, run pdoc with the `--template-directory` (short: `-t`) command line argument:

```
pdoc -t ./examples/custom-template pdoc
```

### Additional Resources for Template Development

 - [pdoc's Default Templates](https://github.com/mitmproxy/pdoc/tree/main/pdoc/templates)
 - [Jinja2 Template Designer Documentation](https://jinja.palletsprojects.com/en/2.11.x/templates/)