Skip to content

Commit

Permalink
Update quickdocs.py
Browse files Browse the repository at this point in the history
  • Loading branch information
dchassin committed Oct 2, 2024
1 parent 0bebd97 commit 1f80ca8
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions quickdocs.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,25 @@
Description:
The `quickdocs` script generates the documentation for a simple Python project.
The `quickdocs` command generates the documentation for a simple Python
project. The formatting is meants to use simple text layout as the input so
that the input can be used for both Python `help()` and the documentation
pages.
The script loads the module specified in the `pyproject.toml` file and
outputs the `__doc__` property of the module. It then documents the python
function and constants, followed by the project metadata.
The command loads the module specified in the `pyproject.toml` file and
outputs the `__doc__` property of the module as the command line
documentation. It then outputs the python functions and constants,
followed by the project metadata.
You can use your project's `pages-build-deployment` workflow to deploy the
documentation to `github.io` or to your own custom site by setting the
following options in your project `Settings-->Pages`:
* `Source`: Choose `Deploy from a branch`
* `Branch`: Choose `main` and `/docs`.
* `Custom domain`: Enter one if you have one.
Usage:
Expand Down

0 comments on commit 1f80ca8

Please sign in to comment.