From b68433ffa2c447ee7eab4ab6032c94da0d5f307e Mon Sep 17 00:00:00 2001 From: zachvalenta Date: Sat, 17 Aug 2019 16:05:03 -0400 Subject: [PATCH 1/2] update docs with CLI cmd to display dostrings only, no src --- pdoc/documentation.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pdoc/documentation.md b/pdoc/documentation.md index c65dc90d..0c9e9845 100644 --- a/pdoc/documentation.md +++ b/pdoc/documentation.md @@ -253,10 +253,16 @@ variable [`PYTHONWARNINGS`][PYTHONWARNINGS] before running pdoc: [PYTHONWARNINGS]: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONWARNINGS +To build documentation that omits the source code in favor of [docstrings only][docstrings], run: + + $ pdoc --html -c show_source_code=False my_package + For brief usage instructions, type: $ pdoc --help +[docstrings]: https://github.com/pdoc3/pdoc/issues/81 + Programmatic usage ------------------ From 47e2aef376f6eec3d577c79ce6a40a29901223d8 Mon Sep 17 00:00:00 2001 From: Kernc Date: Sun, 1 Sep 2019 16:45:01 +0200 Subject: [PATCH 2/2] edit --- pdoc/documentation.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/pdoc/documentation.md b/pdoc/documentation.md index 0c9e9845..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: @@ -253,15 +262,13 @@ variable [`PYTHONWARNINGS`][PYTHONWARNINGS] before running pdoc: [PYTHONWARNINGS]: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONWARNINGS -To build documentation that omits the source code in favor of [docstrings only][docstrings], run: - - $ pdoc --html -c show_source_code=False my_package - For brief usage instructions, type: $ pdoc --help -[docstrings]: https://github.com/pdoc3/pdoc/issues/81 +Even more usage examples can be found in the [FAQ]. + +[FAQ]: https://github.com/pdoc3/pdoc/issues?q=is%3Aissue+label%3Aquestion Programmatic usage