Skip to content

Commit 0502112

Browse files
zachvalentakernc
authored andcommitted
DOC: mention show_source_code=False in Examples (#94)
* update docs with CLI cmd to display dostrings only, no src * edit
1 parent 6443c91 commit 0502112

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

pdoc/documentation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,15 @@ HTML template, run:
239239

240240
$ pdoc --html --output-dir build my_package
241241

242+
If you want to omit the source code preview, run:
243+
244+
$ pdoc --html --config show_source_code=False my_package
245+
246+
Find additional template configuration tunables in [Custom templates]
247+
section below.
248+
249+
[Custom templates]: #custom-templates
250+
242251
To run a local HTTP server while developing your package or writing
243252
docstrings for it, run:
244253

@@ -257,6 +266,10 @@ For brief usage instructions, type:
257266

258267
$ pdoc --help
259268

269+
Even more usage examples can be found in the [FAQ].
270+
271+
[FAQ]: https://github.com/pdoc3/pdoc/issues?q=is%3Aissue+label%3Aquestion
272+
260273

261274
Programmatic usage
262275
------------------

0 commit comments

Comments
 (0)