diff --git a/pdoc/documentation.md b/pdoc/documentation.md index c65dc90d..abbccb2a 100644 --- a/pdoc/documentation.md +++ b/pdoc/documentation.md @@ -239,6 +239,15 @@ HTML template, run: $ pdoc --html --output-dir build my_package +If you want to omit the source code preview, run: + + $ pdoc --html --config show_source_code=False my_package + +Find additional template configuration tunables in [Custom templates] +section below. + +[Custom templates]: #custom-templates + To run a local HTTP server while developing your package or writing docstrings for it, run: @@ -257,6 +266,10 @@ For brief usage instructions, type: $ pdoc --help +Even more usage examples can be found in the [FAQ]. + +[FAQ]: https://github.com/pdoc3/pdoc/issues?q=is%3Aissue+label%3Aquestion + Programmatic usage ------------------