Browse Source

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

* 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
pull/7184/head 0.7.35
fauxpark 4 years ago
committed by Drashna Jaelre
parent
commit
2707652c98
3 changed files with 33 additions and 0 deletions
  1. +10
    -0
      docs/cli.md
  2. +1
    -0
      lib/python/qmk/cli/__init__.py
  3. +22
    -0
      lib/python/qmk/cli/docs.py

+ 10
- 0
docs/cli.md View File

@ -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.


+ 1
- 0
lib/python/qmk/cli/__init__.py View File

@ -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


+ 22
- 0
lib/python/qmk/cli/docs.py View File

@ -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()

Loading…
Cancel
Save