2707652c98
* CLI command to serve docs locally * Document it * Default port * Use `with` and subclass `SimpleHTTPRequestHandler` to set working dir * Apply suggestions from code review Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Update docs/cli.md
23 lines
722 B
Python
23 lines
722 B
Python
"""Serve QMK documentation locally
|
|
"""
|
|
import http.server
|
|
|
|
from milc import cli
|
|
|
|
|
|
class DocsHandler(http.server.SimpleHTTPRequestHandler):
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, directory='docs', **kwargs)
|
|
|
|
|
|
@cli.argument('-p', '--port', default=8936, type=int, help='Port number to use.')
|
|
@cli.subcommand('Run a local webserver for QMK documentation.')
|
|
def docs(cli):
|
|
"""Spin up a local HTTPServer instance for the QMK docs.
|
|
"""
|
|
with http.server.HTTPServer(('', cli.config.docs.port), DocsHandler) as httpd:
|
|
cli.log.info("Serving QMK docs at http://localhost:%d/", cli.config.docs.port)
|
|
cli.log.info("Press Control+C to exit.")
|
|
|
|
httpd.serve_forever()
|