~ruther/qmk_firmware

4735aab75bf86b5bd1e3218c5f5b3f3b51dfba49 — QMK Bot 4 years ago ba1fdf9 + 8b39a3c
Merge remote-tracking branch 'origin/master' into develop
2 files changed, 8 insertions(+), 2 deletions(-)

M docs/cli_commands.md
M lib/python/qmk/cli/docs.py
M docs/cli_commands.md => docs/cli_commands.md +2 -1
@@ 360,11 360,12 @@ qmk format-c -b branch_name
## `qmk docs`

This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser.

**Usage**:

```
qmk docs [-p PORT]
qmk docs [-b] [-p PORT]
```

## `qmk generate-docs`

M lib/python/qmk/cli/docs.py => lib/python/qmk/cli/docs.py +6 -1
@@ 2,11 2,13 @@
"""
import http.server
import os
import webbrowser

from milc import cli


@cli.argument('-p', '--port', default=8936, type=int, help='Port number to use.')
@cli.argument('-b', '--browser', action='store_true', help='Open the docs in the default browser.')
@cli.subcommand('Run a local webserver for QMK documentation.', hidden=False if cli.config.user.developer else True)
def docs(cli):
    """Spin up a local HTTPServer instance for the QMK docs.


@@ 14,9 16,12 @@ def docs(cli):
    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(f"Serving QMK docs at http://localhost:{cli.config.docs.port}/")
        cli.log.info("Press Control+C to exit.")

        if cli.config.docs.browser:
            webbrowser.open(f'http://localhost:{cli.config.docs.port}')

        try:
            httpd.serve_forever()
        except KeyboardInterrupt: