doc: add snippets documentation
Document this new build system feature. Since its purpose is customizing application builds, the logical place for the main body of documentation is in a new snippets/ directory in doc/build/. Create that directory and add its initial documentation. Like boards and samples, however, we expect people to write documentation for each snippet within the directory that defines the snippet itself. Therefore, add a new top-level snippets/ directory and stub out the documentation needed to document individual snippets as well. Add documentation and cross-references in other required places as well. Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
This commit is contained in:
parent
1f9ab85354
commit
ee4b134dd6
9 changed files with 314 additions and 0 deletions
|
@ -269,6 +269,7 @@ vcs_link_base_url = f"https://github.com/zephyrproject-rtos/zephyr/blob/{vcs_lin
|
|||
vcs_link_prefixes = {
|
||||
"samples/.*": "",
|
||||
"boards/.*": "",
|
||||
"snippets/.*": "",
|
||||
".*": "doc",
|
||||
}
|
||||
vcs_link_exclude = [
|
||||
|
@ -290,6 +291,8 @@ external_content_contents = [
|
|||
(ZEPHYR_BASE, "boards/**/doc"),
|
||||
(ZEPHYR_BASE, "samples/**/*.rst"),
|
||||
(ZEPHYR_BASE, "samples/**/doc"),
|
||||
(ZEPHYR_BASE, "snippets/**/*.rst"),
|
||||
(ZEPHYR_BASE, "snippets/**/doc"),
|
||||
]
|
||||
external_content_keep = [
|
||||
"reference/kconfig/*",
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue