aboutsummaryrefslogtreecommitdiff
path: root/lib/python/qmk
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk')
-rw-r--r--lib/python/qmk/cli/docs.py9
-rw-r--r--lib/python/qmk/cli/generate/docs.py6
-rw-r--r--lib/python/qmk/docs.py8
3 files changed, 12 insertions, 11 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)
diff --git a/lib/python/qmk/cli/generate/docs.py b/lib/python/qmk/cli/generate/docs.py
index 5821d43b86..7abeca9d2a 100644
--- a/lib/python/qmk/cli/generate/docs.py
+++ b/lib/python/qmk/cli/generate/docs.py
@@ -27,10 +27,8 @@ def generate_docs(cli):
return False
cli.log.info('Building vitepress docs')
- run_docs_command('run', 'docs:build')
+ run_docs_command('run', ['docs:build'])
cli.log.info('Successfully generated docs to %s.', BUILD_DOCS_PATH)
if cli.args.serve:
- if not cli.config.general.verbose:
- cli.log.info('Serving docs at http://localhost:4173/ (Ctrl+C to stop)')
- run_docs_command('run', 'docs:preview')
+ run_docs_command('run', ['docs:preview'])
diff --git a/lib/python/qmk/docs.py b/lib/python/qmk/docs.py
index 56694cf6ae..75d2d60bda 100644
--- a/lib/python/qmk/docs.py
+++ b/lib/python/qmk/docs.py
@@ -17,18 +17,18 @@ BUILD_DOCS_PATH = BUILD_PATH / 'docs'
DOXYGEN_PATH = BUILD_DOCS_PATH / 'static' / 'doxygen'
-def run_docs_command(verb, cmd=None):
+def run_docs_command(verb, cmd_args=None):
environ['PATH'] += pathsep + str(NODE_MODULES_PATH / '.bin')
- args = {'capture_output': False if cli.config.general.verbose else True, 'check': True, 'stdin': DEVNULL}
+ args = {'capture_output': False, 'check': True}
docs_env = environ.copy()
if cli.config.general.verbose:
docs_env['DEBUG'] = 'vitepress:*,vite:*'
args['env'] = docs_env
arg_list = ['yarn', verb]
- if cmd:
- arg_list.append(cmd)
+ if cmd_args:
+ arg_list.extend(cmd_args)
chdir(BUILDDEFS_PATH)
cli.run(arg_list, **args)