summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-07-30 23:47:34 +1000
committerGitHub <noreply@github.com>2021-07-30 14:47:34 +0100
commit8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f (patch)
tree77bb1760457be78790dc46480a7668b8b85947a7
parentd93089d8eaffa4fc6d3c41fd513b005bc8ff6562 (diff)
downloadqmk_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.md3
-rw-r--r--lib/python/qmk/cli/docs.py7
2 files changed, 8 insertions, 2 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 581342093a..4e27622c74 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -349,11 +349,12 @@ qmk cformat -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.')
+@cli.argument('-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: