summaryrefslogtreecommitdiff
path: root/lib/python/qmk
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 /lib/python/qmk
parentd93089d8eaffa4fc6d3c41fd513b005bc8ff6562 (diff)
`qmk docs`: Add flag to open in browser (#13788)
* `qmk docs`: Add flag to open in browser * Add docs
Diffstat (limited to 'lib/python/qmk')
-rw-r--r--lib/python/qmk/cli/docs.py7
1 files changed, 6 insertions, 1 deletions
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: