~ruther/qmk_firmware

45a8176e325130775b51058199e69aa8f06c88cc — QMK Bot 3 years ago d4bbecb + 6437045
Merge remote-tracking branch 'origin/master' into develop
2 files changed, 25 insertions(+), 9 deletions(-)

M docs/cli_commands.md
M lib/python/qmk/cli/docs.py
M docs/cli_commands.md => docs/cli_commands.md +2 -0
@@ 352,6 352,8 @@ Now open your dev environment and live a squiggly-free life.
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.

This command runs `docsify serve` if `docsify-cli` is installed (which provides live reload), otherwise Python's builtin HTTP server module will be used.

**Usage**:

```

M lib/python/qmk/cli/docs.py => lib/python/qmk/cli/docs.py +23 -9
@@ 2,6 2,7 @@
"""
import http.server
import os
import shutil
import webbrowser

from milc import cli


@@ 11,20 12,33 @@ from milc import cli
@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.
    """Spin up a local HTTP server for the QMK docs.
    """
    os.chdir('docs')

    with http.server.HTTPServer(('', cli.config.docs.port), http.server.SimpleHTTPRequestHandler) as httpd:
        cli.log.info(f"Serving QMK docs at http://localhost:{cli.config.docs.port}/")
        cli.log.info("Press Control+C to exit.")
    # If docsify-cli is installed, run that instead so we get live reload
    if shutil.which('docsify'):
        command = ['docsify', 'serve', '--port', f'{cli.config.docs.port}', '--open' if cli.config.docs.browser else '']

        if cli.config.docs.browser:
            webbrowser.open(f'http://localhost:{cli.config.docs.port}')
        cli.log.info(f"Running {{fg_cyan}}{str.join(' ', command)}{{fg_reset}}")
        cli.log.info("Press Control+C to exit.")

        try:
            httpd.serve_forever()
            cli.run(command, capture_output=False)
        except KeyboardInterrupt:
            cli.log.info("Stopping HTTP server...")
        finally:
            httpd.shutdown()
    else:
        # Fall back to Python HTTPServer
        with http.server.HTTPServer(('', cli.config.docs.port), http.server.SimpleHTTPRequestHandler) as httpd:
            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:
                cli.log.info("Stopping HTTP server...")
            finally:
                httpd.shutdown()