[Docs] CLI command to serve docs locally (#6956)0.7.35

* 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

3 files changed, 33 insertions, 0 deletions

diff --git a/docs/cli.md b/docs/cli.md
index 6ffe033653..d150ee917d 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -105,6 +105,16 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d
 qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
 ```
 
+## `qmk docs`
+
+This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
+
+**Usage**:
+
+```
+qmk docs [-p PORT]
+```
+
 ## `qmk doctor`
 
 This command examines your environment and alerts you to potential build or flash problems.
diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py
index e982a75fc8..e41cc3dcb2 100644
--- a/lib/python/qmk/cli/__init__.py
+++ b/lib/python/qmk/cli/__init__.py
@@ -5,6 +5,7 @@ We list each subcommand here explicitly because all the reliable ways of searchi
 from . import cformat
 from . import compile
 from . import config
+from . import docs
 from . import doctor
 from . import hello
 from . import json
diff --git a/lib/python/qmk/cli/docs.py b/lib/python/qmk/cli/docs.py
new file mode 100644
index 0000000000..a0888ec388
--- /dev/null
+++ b/lib/python/qmk/cli/docs.py
@@ -0,0 +1,22 @@
+"""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()