summaryrefslogtreecommitdiffstats
path: root/lib/python/qmk/cli/generate/docs.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/cli/generate/docs.py')
-rw-r--r--lib/python/qmk/cli/generate/docs.py37
1 files changed, 37 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/generate/docs.py b/lib/python/qmk/cli/generate/docs.py
new file mode 100644
index 0000000000..a59a24db50
--- /dev/null
+++ b/lib/python/qmk/cli/generate/docs.py
@@ -0,0 +1,37 @@
+"""Build QMK documentation locally
+"""
+import shutil
+import subprocess
+from pathlib import Path
+
+from milc import cli
+
+DOCS_PATH = Path('docs/')
+BUILD_PATH = Path('.build/docs/')
+
+
+@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 BUILD_PATH.exists():
+ shutil.rmtree(BUILD_PATH)
+
+ shutil.copytree(DOCS_PATH, BUILD_PATH)
+
+ # When not verbose we want to hide all output
+ args = {'check': True}
+ if not cli.args.verbose:
+ args.update({'stdout': subprocess.DEVNULL, 'stderr': subprocess.STDOUT})
+
+ cli.log.info('Generating internal docs...')
+
+ # Generate internal docs
+ subprocess.run(['doxygen', 'Doxyfile'], **args)
+ subprocess.run(['moxygen', '-q', '-a', '-g', '-o', BUILD_PATH / 'internals_%s.md', 'doxygen/xml'], **args)
+
+ cli.log.info('Successfully generated internal docs to %s.', BUILD_PATH)