aboutsummaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/docs.py
diff options
context:
space:
mode:
authorRyan <[email protected]>2025-02-01 21:19:30 +1100
committerGitHub <[email protected]>2025-02-01 21:19:30 +1100
commit273d8d6a1a6badb8d9b473954f16a0fbbe671987 (patch)
tree0d2558d1d8ae2ce22c5b6702abc5315c607e2c12 /lib/python/qmk/cli/docs.py
parentff09b921f1c2160abe05c1fdbd38f25f64b6c7bd (diff)
downloadqmk_firmware-273d8d6a1a6badb8d9b473954f16a0fbbe671987.tar.gz
qmk_firmware-273d8d6a1a6badb8d9b473954f16a0fbbe671987.zip
`qmk docs`: restore `--port` and `--browser` arguments (#24623)
* `qmk docs`: restore `--port` and `--browser` arguments * Make docs command args always a list
Diffstat (limited to 'lib/python/qmk/cli/docs.py')
-rw-r--r--lib/python/qmk/cli/docs.py9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/python/qmk/cli/docs.py b/lib/python/qmk/cli/docs.py
index d28dddf194..da02ebf95e 100644
--- a/lib/python/qmk/cli/docs.py
+++ b/lib/python/qmk/cli/docs.py
@@ -6,6 +6,8 @@ from qmk.docs import prepare_docs_build_area, run_docs_command
from milc import cli
[email protected]('-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 HTTP server for the QMK docs.
@@ -22,6 +24,7 @@ def docs(cli):
if not prepare_docs_build_area(is_production=False):
return False
- if not cli.config.general.verbose:
- cli.log.info('Serving docs at http://localhost:5173/ (Ctrl+C to stop)')
- run_docs_command('run', 'docs:dev')
+ cmd = ['docs:dev', '--port', f'{cli.args.port}']
+ if cli.args.browser:
+ cmd.append('--open')
+ run_docs_command('run', cmd)