diff options
| author | QMK Bot <[email protected]> | 2021-07-30 13:48:29 +0000 | 
|---|---|---|
| committer | QMK Bot <[email protected]> | 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 876ffb5831..314e7448d7 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -360,11 +360,12 @@ qmk format-c -b branch_name  ## `qmk docs`  This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. +Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser.  **Usage**:  ``` -qmk docs [-p PORT] +qmk docs [-b] [-p PORT]  ```  ## `qmk generate-docs` diff --git a/lib/python/qmk/cli/docs.py b/lib/python/qmk/cli/docs.py index 5816106504..d8f9b045a1 100644 --- a/lib/python/qmk/cli/docs.py +++ b/lib/python/qmk/cli/docs.py @@ -2,11 +2,13 @@  """  import http.server  import os +import webbrowser  from milc import cli  @cli.argument('-p', '--port', default=8936, type=int, help='Port number to use.') [email protected]('-b', '--browser', action='store_true', help='Open the docs in the default browser.')  @cli.subcommand('Run a local webserver for QMK documentation.', hidden=False if cli.config.user.developer else True)  def docs(cli):      """Spin up a local HTTPServer instance for the QMK docs. @@ -14,9 +16,12 @@ def docs(cli):      os.chdir('docs')      with http.server.HTTPServer(('', cli.config.docs.port), http.server.SimpleHTTPRequestHandler) as httpd: -        cli.log.info("Serving QMK docs at http://localhost:%d/", cli.config.docs.port) +        cli.log.info(f"Serving QMK docs at http://localhost:{cli.config.docs.port}/")          cli.log.info("Press Control+C to exit.") +        if cli.config.docs.browser: +            webbrowser.open(f'http://localhost:{cli.config.docs.port}') +          try:              httpd.serve_forever()          except KeyboardInterrupt: | 
