blob: 7abeca9d2abd7236189278ca332b02f6fb59bfed (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
"""Build QMK documentation locally
"""
import shutil
from qmk.docs import prepare_docs_build_area, run_docs_command, BUILD_DOCS_PATH
from milc import cli
@cli.argument('-s', '--serve', arg_only=True, action='store_true', help="Serves the generated docs once built.")
@cli.subcommand('Build QMK documentation.', hidden=False if cli.config.user.developer else True)
def generate_docs(cli):
"""Invoke the docs generation process
TODO(unclaimed):
* [ ] Add a real build step... something static docs
"""
if not shutil.which('doxygen'):
cli.log.error('doxygen is not installed. Please install it and try again.')
return
if not shutil.which('yarn'):
cli.log.error('yarn is not installed. Please install it and try again.')
return
if not prepare_docs_build_area(is_production=True):
return False
cli.log.info('Building vitepress docs')
run_docs_command('run', ['docs:build'])
cli.log.info('Successfully generated docs to %s.', BUILD_DOCS_PATH)
if cli.args.serve:
run_docs_command('run', ['docs:preview'])
|