diff options
| author | Joel Challis <git@zvecr.com> | 2020-11-10 15:00:40 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-10 07:00:40 -0800 |
| commit | aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 (patch) | |
| tree | 3d9adfd3eea4a72779b82787ed8210a1971832c5 /docs | |
| parent | abf1902ff597e77e910c0fb9a8d132b46f78317b (diff) | |
CI: Add docs build and deploy workflow (#7448)
* Add docs build and deploy workflow
* Remove old travis docs workflow
* update to cli command
* Tidy up for review
* formatting
* Update to pass style checks
* Update lib/python/qmk/cli/docs.py
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Review comments - build->generate, use of verbose
* Add docs
* Update to match recent actions
* Run within base_container
* Convert cli to generate-docs
* Convert cli to generate-docs - restore old file
* Convert cli to generate-docs
* Update docs
Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli_commands.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index b10f5d4995..69df82f953 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -286,6 +286,16 @@ This command starts a local HTTP server which you can use for browsing or improv qmk docs [-p PORT] ``` +## `qmk generate-docs` + +This command allows you to generate QMK documentation locally. It can be uses for general browsing or improving the docs. External tools such as [serve](https://www.npmjs.com/package/serve) can be used to browse the generated files. + +**Usage**: + +``` +qmk generate-docs +``` + ## `qmk kle2json` This command allows you to convert from raw KLE data to QMK Configurator JSON. It accepts either an absolute file path, or a file name in the current directory. By default it will not overwrite `info.json` if it is already present. Use the `-f` or `--force` flag to overwrite. |