diff options
| author | QMK Bot <hello@qmk.fm> | 2021-07-30 13:48:29 +0000 |
|---|---|---|
| committer | QMK Bot <hello@qmk.fm> | 2021-07-30 13:48:29 +0000 |
| commit | 4735aab75bf86b5bd1e3218c5f5b3f3b51dfba49 (patch) | |
| tree | 23d353a80d9c30564c047be27d3c965e997ac79a | |
| parent | ba1fdf97b13c60393de5bfe30d25a3e48368cb2c (diff) | |
| parent | 8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f (diff) | |
| download | qmk_firmware-4735aab75bf86b5bd1e3218c5f5b3f3b51dfba49.tar.gz qmk_firmware-4735aab75bf86b5bd1e3218c5f5b3f3b51dfba49.zip | |
Merge remote-tracking branch 'origin/master' into develop
| -rw-r--r-- | docs/cli_commands.md | 3 | ||||
| -rw-r--r-- | lib/python/qmk/cli/docs.py | 7 |
2 files changed, 8 insertions, 2 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 876ffb583..314e7448d 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -360,11 +360,12 @@ qmk format-c -b branch_name | |||
| 360 | ## `qmk docs` | 360 | ## `qmk docs` |
| 361 | 361 | ||
| 362 | This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. | 362 | This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. |
| 363 | Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser. | ||
| 363 | 364 | ||
| 364 | **Usage**: | 365 | **Usage**: |
| 365 | 366 | ||
| 366 | ``` | 367 | ``` |
| 367 | qmk docs [-p PORT] | 368 | qmk docs [-b] [-p PORT] |
| 368 | ``` | 369 | ``` |
| 369 | 370 | ||
| 370 | ## `qmk generate-docs` | 371 | ## `qmk generate-docs` |
diff --git a/lib/python/qmk/cli/docs.py b/lib/python/qmk/cli/docs.py index 581610650..d8f9b045a 100644 --- a/lib/python/qmk/cli/docs.py +++ b/lib/python/qmk/cli/docs.py | |||
| @@ -2,11 +2,13 @@ | |||
| 2 | """ | 2 | """ |
| 3 | import http.server | 3 | import http.server |
| 4 | import os | 4 | import os |
| 5 | import webbrowser | ||
| 5 | 6 | ||
| 6 | from milc import cli | 7 | from milc import cli |
| 7 | 8 | ||
| 8 | 9 | ||
| 9 | @cli.argument('-p', '--port', default=8936, type=int, help='Port number to use.') | 10 | @cli.argument('-p', '--port', default=8936, type=int, help='Port number to use.') |
| 11 | @cli.argument('-b', '--browser', action='store_true', help='Open the docs in the default browser.') | ||
| 10 | @cli.subcommand('Run a local webserver for QMK documentation.', hidden=False if cli.config.user.developer else True) | 12 | @cli.subcommand('Run a local webserver for QMK documentation.', hidden=False if cli.config.user.developer else True) |
| 11 | def docs(cli): | 13 | def docs(cli): |
| 12 | """Spin up a local HTTPServer instance for the QMK docs. | 14 | """Spin up a local HTTPServer instance for the QMK docs. |
| @@ -14,9 +16,12 @@ def docs(cli): | |||
| 14 | os.chdir('docs') | 16 | os.chdir('docs') |
| 15 | 17 | ||
| 16 | with http.server.HTTPServer(('', cli.config.docs.port), http.server.SimpleHTTPRequestHandler) as httpd: | 18 | with http.server.HTTPServer(('', cli.config.docs.port), http.server.SimpleHTTPRequestHandler) as httpd: |
| 17 | cli.log.info("Serving QMK docs at http://localhost:%d/", cli.config.docs.port) | 19 | cli.log.info(f"Serving QMK docs at http://localhost:{cli.config.docs.port}/") |
| 18 | cli.log.info("Press Control+C to exit.") | 20 | cli.log.info("Press Control+C to exit.") |
| 19 | 21 | ||
| 22 | if cli.config.docs.browser: | ||
| 23 | webbrowser.open(f'http://localhost:{cli.config.docs.port}') | ||
| 24 | |||
| 20 | try: | 25 | try: |
| 21 | httpd.serve_forever() | 26 | httpd.serve_forever() |
| 22 | except KeyboardInterrupt: | 27 | except KeyboardInterrupt: |
