aboutsummaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/docs.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/cli/docs.py')
-rw-r--r--lib/python/qmk/cli/docs.py22
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/docs.py b/lib/python/qmk/cli/docs.py
new file mode 100644
index 000000000..a0888ec38
--- /dev/null
+++ b/lib/python/qmk/cli/docs.py
@@ -0,0 +1,22 @@
1"""Serve QMK documentation locally
2"""
3import http.server
4
5from milc import cli
6
7
8class DocsHandler(http.server.SimpleHTTPRequestHandler):
9 def __init__(self, *args, **kwargs):
10 super().__init__(*args, directory='docs', **kwargs)
11
12
13@cli.argument('-p', '--port', default=8936, type=int, help='Port number to use.')
14@cli.subcommand('Run a local webserver for QMK documentation.')
15def docs(cli):
16 """Spin up a local HTTPServer instance for the QMK docs.
17 """
18 with http.server.HTTPServer(('', cli.config.docs.port), DocsHandler) as httpd:
19 cli.log.info("Serving QMK docs at http://localhost:%d/", cli.config.docs.port)
20 cli.log.info("Press Control+C to exit.")
21
22 httpd.serve_forever()