Skip to content

DOC: mention show_source_code=False in Examples #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 1, 2019
Merged

DOC: mention show_source_code=False in Examples #94

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b68433f
update docs with CLI cmd to display dostrings only, no src
zachvalenta Aug 17, 2019
47e2aef
edit
kernc Sep 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions pdoc/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
------------------
Expand Down