summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2022-03-07 22:22:22 +1100
committerGitHub <noreply@github.com>2022-03-07 11:22:22 +0000
commit75544d91273d1ae9f0255556dc5170478a1a6e49 (patch)
treebf63910bcfa37732468f0e918eea79489195a07e /lib
parent44f1bd9b3a9185951c283ceb5eeb2ecc2be72418 (diff)
downloadqmk_firmware-75544d91273d1ae9f0255556dc5170478a1a6e49.tar.gz
qmk_firmware-75544d91273d1ae9f0255556dc5170478a1a6e49.zip
Move Doxygen docs to subdirectory (#16561)
Diffstat (limited to 'lib')
-rw-r--r--lib/python/qmk/cli/generate/docs.py7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/python/qmk/cli/generate/docs.py b/lib/python/qmk/cli/generate/docs.py
index 74112d834d..eb3099e138 100644
--- a/lib/python/qmk/cli/generate/docs.py
+++ b/lib/python/qmk/cli/generate/docs.py
@@ -10,6 +10,7 @@ DOCS_PATH = Path('docs/')
BUILD_PATH = Path('.build/')
BUILD_DOCS_PATH = BUILD_PATH / 'docs'
DOXYGEN_PATH = BUILD_PATH / 'doxygen'
+MOXYGEN_PATH = BUILD_DOCS_PATH / 'internals'
@cli.subcommand('Build QMK documentation.', hidden=False if cli.config.user.developer else True)
@@ -34,10 +35,10 @@ def generate_docs(cli):
'stdin': DEVNULL,
}
- cli.log.info('Generating internal docs...')
+ cli.log.info('Generating docs...')
# Generate internal docs
cli.run(['doxygen', 'Doxyfile'], **args)
- cli.run(['moxygen', '-q', '-g', '-o', BUILD_DOCS_PATH / 'internals_%s.md', DOXYGEN_PATH / 'xml'], **args)
+ cli.run(['moxygen', '-q', '-g', '-o', MOXYGEN_PATH / '%s.md', DOXYGEN_PATH / 'xml'], **args)
- cli.log.info('Successfully generated internal docs to %s.', BUILD_DOCS_PATH)
+ cli.log.info('Successfully generated docs to %s.', BUILD_DOCS_PATH)