From 874a6c9076bb89999f87f6285cd946adf6129a15 Mon Sep 17 00:00:00 2001 From: Erovia Date: Sun, 22 Mar 2020 19:48:30 +0100 Subject: 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 --- lib/python/qmk/cli/docs.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 lib/python/qmk/cli/docs.py (limited to 'lib/python/qmk/cli/docs.py') diff --git a/lib/python/qmk/cli/docs.py b/lib/python/qmk/cli/docs.py new file mode 100644 index 0000000000..1d655ecaa7 --- /dev/null +++ b/lib/python/qmk/cli/docs.py @@ -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() -- cgit v1.2.3