gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-17 21:22:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Safety checks for required apps.

Browse Source
This commit is contained in:
Nick Brassel 2023-05-01 17:23:46 +10:00
parent bdcf3c69c9
commit 6e2d02852c
No known key found for this signature in database
3 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
builddefs/docs/sidebars.js
View File

@ -251,9 +251,9 @@ const sidebars = {
type: 'category', type: 'category',
label: "Past Breaking Changes", label: "Past Breaking Changes",
link: { link: {
type: 'generated-index', type: 'generated-index',
title: 'Past Breaking Changes', title: 'Past Breaking Changes',
slug: '/breaking_changes/all', slug: '/breaking_changes/all',
}, },
items: [ items: [
{ {

10
lib/python/qmk/cli/docs.py
View File

@ -1,5 +1,6 @@
"""Serve QMK documentation locally """Serve QMK documentation locally
""" """
import shutil
from qmk.docs import prepare_docs_build_area, run_docs_command from qmk.docs import prepare_docs_build_area, run_docs_command
from milc import cli from milc import cli
@ -9,5 +10,14 @@ from milc import cli
def docs(cli): def docs(cli):
"""Spin up a local HTTP server for the QMK docs. """Spin up a local HTTP server for the QMK docs.
""" """
if not shutil.which('doxygen'):
cli.log.error('doxygen is not installed. Please install it and try again.')
return
if not shutil.which('npm'):
cli.log.error('npm is not installed. Please install it and try again.')
return
prepare_docs_build_area() prepare_docs_build_area()
run_docs_command('start', False) run_docs_command('start', False)

9
lib/python/qmk/cli/generate/docs.py
View File

@ -1,5 +1,6 @@
"""Build QMK documentation locally """Build QMK documentation locally
""" """
import shutil
from qmk.docs import prepare_docs_build_area, run_docs_command, BUILD_DOCS_PATH from qmk.docs import prepare_docs_build_area, run_docs_command, BUILD_DOCS_PATH
from milc import cli from milc import cli
@ -14,6 +15,14 @@ def generate_docs(cli):
* [ ] Add a real build step... something static docs * [ ] 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('npm'):
cli.log.error('npm is not installed. Please install it and try again.')
return
prepare_docs_build_area() prepare_docs_build_area()
cli.log.info('Building docusaurus docs') cli.log.info('Building docusaurus docs')