aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2022-02-22 02:47:44 +1100
committerGitHub <noreply@github.com>2022-02-21 15:47:44 +0000
commitf30f963a0b6ccaa151fe83dd8302fa1f6829086e (patch)
tree12a91b56de63ad064de2cbbf68e79001f659d4b1
parentb1de11c27575f9956d2f7dfd6bf0240d630e3ae1 (diff)
downloadqmk_firmware-f30f963a0b6ccaa151fe83dd8302fa1f6829086e.tar.gz
qmk_firmware-f30f963a0b6ccaa151fe83dd8302fa1f6829086e.zip
Internal docs generation updates (#16411)
-rw-r--r--.gitignore1
-rw-r--r--Doxyfile6
-rw-r--r--lib/python/qmk/cli/generate/docs.py16
3 files changed, 13 insertions, 10 deletions
diff --git a/.gitignore b/.gitignore
index 768f40b19..3cc40dc2a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,7 +18,6 @@
18 18
19# QMK-specific 19# QMK-specific
20api_data/v1 20api_data/v1
21doxygen/
22quantum/version.h 21quantum/version.h
23*.bin 22*.bin
24*.eep 23*.eep
diff --git a/Doxyfile b/Doxyfile
index 218d77b4d..4b0ea3f08 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -21,7 +21,7 @@ DOXYFILE_ENCODING = UTF-8
21PROJECT_NAME = "QMK Firmware" 21PROJECT_NAME = "QMK Firmware"
22PROJECT_NUMBER = https://github.com/qmk/qmk_firmware 22PROJECT_NUMBER = https://github.com/qmk/qmk_firmware
23PROJECT_BRIEF = "Keyboard controller firmware for Atmel AVR and ARM USB families" 23PROJECT_BRIEF = "Keyboard controller firmware for Atmel AVR and ARM USB families"
24OUTPUT_DIRECTORY = doxygen 24OUTPUT_DIRECTORY = .build/doxygen
25ALLOW_UNICODE_NAMES = NO 25ALLOW_UNICODE_NAMES = NO
26OUTPUT_LANGUAGE = English 26OUTPUT_LANGUAGE = English
27BRIEF_MEMBER_DESC = YES 27BRIEF_MEMBER_DESC = YES
@@ -145,7 +145,7 @@ FILE_PATTERNS = *.c \
145RECURSIVE = YES 145RECURSIVE = YES
146EXCLUDE = 146EXCLUDE =
147EXCLUDE_SYMLINKS = NO 147EXCLUDE_SYMLINKS = NO
148EXCLUDE_PATTERNS = 148EXCLUDE_PATTERNS = */protocol/arm_atsam/*
149EXCLUDE_SYMBOLS = 149EXCLUDE_SYMBOLS =
150EXAMPLE_PATH = 150EXAMPLE_PATH =
151EXAMPLE_PATTERNS = * 151EXAMPLE_PATTERNS = *
@@ -209,7 +209,7 @@ EXPAND_ONLY_PREDEF = NO
209SEARCH_INCLUDES = YES 209SEARCH_INCLUDES = YES
210INCLUDE_PATH = 210INCLUDE_PATH =
211INCLUDE_FILE_PATTERNS = 211INCLUDE_FILE_PATTERNS =
212PREDEFINED = 212PREDEFINED = __DOXYGEN__ PROGMEM
213EXPAND_AS_DEFINED = 213EXPAND_AS_DEFINED =
214SKIP_FUNCTION_MACROS = YES 214SKIP_FUNCTION_MACROS = YES
215 215
diff --git a/lib/python/qmk/cli/generate/docs.py b/lib/python/qmk/cli/generate/docs.py
index 749336fea..74112d834 100644
--- a/lib/python/qmk/cli/generate/docs.py
+++ b/lib/python/qmk/cli/generate/docs.py
@@ -7,7 +7,9 @@ from subprocess import DEVNULL
7from milc import cli 7from milc import cli
8 8
9DOCS_PATH = Path('docs/') 9DOCS_PATH = Path('docs/')
10BUILD_PATH = Path('.build/docs/') 10BUILD_PATH = Path('.build/')
11BUILD_DOCS_PATH = BUILD_PATH / 'docs'
12DOXYGEN_PATH = BUILD_PATH / 'doxygen'
11 13
12 14
13@cli.subcommand('Build QMK documentation.', hidden=False if cli.config.user.developer else True) 15@cli.subcommand('Build QMK documentation.', hidden=False if cli.config.user.developer else True)
@@ -18,10 +20,12 @@ def generate_docs(cli):
18 * [ ] Add a real build step... something static docs 20 * [ ] Add a real build step... something static docs
19 """ 21 """
20 22
21 if BUILD_PATH.exists(): 23 if BUILD_DOCS_PATH.exists():
22 shutil.rmtree(BUILD_PATH) 24 shutil.rmtree(BUILD_DOCS_PATH)
25 if DOXYGEN_PATH.exists():
26 shutil.rmtree(DOXYGEN_PATH)
23 27
24 shutil.copytree(DOCS_PATH, BUILD_PATH) 28 shutil.copytree(DOCS_PATH, BUILD_DOCS_PATH)
25 29
26 # When not verbose we want to hide all output 30 # When not verbose we want to hide all output
27 args = { 31 args = {
@@ -34,6 +38,6 @@ def generate_docs(cli):
34 38
35 # Generate internal docs 39 # Generate internal docs
36 cli.run(['doxygen', 'Doxyfile'], **args) 40 cli.run(['doxygen', 'Doxyfile'], **args)
37 cli.run(['moxygen', '-q', '-a', '-g', '-o', BUILD_PATH / 'internals_%s.md', 'doxygen/xml'], **args) 41 cli.run(['moxygen', '-q', '-g', '-o', BUILD_DOCS_PATH / 'internals_%s.md', DOXYGEN_PATH / 'xml'], **args)
38 42
39 cli.log.info('Successfully generated internal docs to %s.', BUILD_PATH) 43 cli.log.info('Successfully generated internal docs to %s.', BUILD_DOCS_PATH)