qmk_firmware/lib/python/qmk/cli/docs.py

26 lines
821 B
Python
Raw Normal View History

"""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.')
2020-03-23 20:59:44 +00:00
@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.
"""
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()