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/cformat.py | 2 +- lib/python/qmk/cli/docs.py | 25 +++++++++++++++++++++++++ lib/python/qmk/cli/kle2json.py | 2 +- 3 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 lib/python/qmk/cli/docs.py (limited to 'lib/python') diff --git a/lib/python/qmk/cli/cformat.py b/lib/python/qmk/cli/cformat.py index 7e3a91dcf0..48f8b9bcc4 100644 --- a/lib/python/qmk/cli/cformat.py +++ b/lib/python/qmk/cli/cformat.py @@ -35,7 +35,7 @@ def cformat_run(files, all_files): @cli.argument('-a', '--all-files', arg_only=True, action='store_true', help='Format all core files.') @cli.argument('-b', '--base-branch', default='origin/master', help='Branch to compare to diffs to.') @cli.argument('files', nargs='*', arg_only=True, help='Filename(s) to format.') -@cli.subcommand("Format C code according to QMK's style.") +@cli.subcommand("Format C code according to QMK's style.", hidden=True) def cformat(cli): """Format C code according to QMK's style. """ 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() diff --git a/lib/python/qmk/cli/kle2json.py b/lib/python/qmk/cli/kle2json.py index 00f63d3622..4e74e75a31 100755 --- a/lib/python/qmk/cli/kle2json.py +++ b/lib/python/qmk/cli/kle2json.py @@ -26,7 +26,7 @@ class CustomJSONEncoder(json.JSONEncoder): @cli.argument('filename', help='The KLE raw txt to convert') @cli.argument('-f', '--force', action='store_true', help='Flag to overwrite current info.json') -@cli.subcommand('Convert a KLE layout to a Configurator JSON') +@cli.subcommand('Convert a KLE layout to a Configurator JSON', hidden=True) def kle2json(cli): """Convert a KLE layout to QMK's layout format. """ # If filename is a path -- cgit v1.2.3