diff options
| author | Ryan <fauxpark@gmail.com> | 2021-07-30 23:47:34 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-30 14:47:34 +0100 |
| commit | 8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f (patch) | |
| tree | 77bb1760457be78790dc46480a7668b8b85947a7 | |
| parent | d93089d8eaffa4fc6d3c41fd513b005bc8ff6562 (diff) | |
| download | qmk_firmware-8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f.tar.gz qmk_firmware-8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f.zip | |
`qmk docs`: Add flag to open in browser (#13788)
* `qmk docs`: Add flag to open in browser
* Add docs
| -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 581342093..4e27622c7 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -349,11 +349,12 @@ qmk cformat -b branch_name | |||
| 349 | ## `qmk docs` | 349 | ## `qmk docs` |
| 350 | 350 | ||
| 351 | This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. | 351 | This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. |
| 352 | Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser. | ||
| 352 | 353 | ||
| 353 | **Usage**: | 354 | **Usage**: |
| 354 | 355 | ||
| 355 | ``` | 356 | ``` |
| 356 | qmk docs [-p PORT] | 357 | qmk docs [-b] [-p PORT] |
| 357 | ``` | 358 | ``` |
| 358 | 359 | ||
| 359 | ## `qmk generate-docs` | 360 | ## `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: |
