Rebase on master, hide some other subcommands
The list of hidden subcommands were approved by @skullydazed ;) Currently hidden if 'user.developer' is not True: - cformat - docs - kle2json - pyformat - pytest
This commit is contained in:
25
lib/python/qmk/cli/docs.py
Normal file
25
lib/python/qmk/cli/docs.py
Normal file
@@ -0,0 +1,25 @@
|
||||
"""Serve QMK documentation locally
|
||||
"""
|
||||
import http.server
|
||||
import os
|
||||
|
||||
from milc import cli
|
||||
|
||||
|
||||
@cli.argument('-p', '--port', default=8936, type=int, help='Port number to use.')
|
||||
@cli.subcommand('Run a local webserver for QMK documentation.', hidden=True)
|
||||
def docs(cli):
|
||||
"""Spin up a local HTTPServer instance for the QMK docs.
|
||||
"""
|
||||
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("Press Control+C to exit.")
|
||||
|
||||
try:
|
||||
httpd.serve_forever()
|
||||
except KeyboardInterrupt:
|
||||
cli.log.info("Stopping HTTP server...")
|
||||
finally:
|
||||
httpd.shutdown()
|
||||
Reference in New Issue
Block a user