OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: add template for external modules 

Add template for external modules. Add a module file under external/
will list the module under

https://docs.zephyrproject.org/latest/develop/manifest/index.html#external-projects-modules

which then can be referenced from within the tree where it makes sense.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2023-12-21 17:03:19 -05:00 committed by Carles Cufí
parent 5a2359332f
commit 7c7407849f
2 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/develop/manifest/external/external.rst.tmpl vendored Normal file
View File

@ -0,0 +1,19 @@
.. _external_module_<name>:
<External Module Name>
#######################
Introduction
************
Short intro into the module and how it relates to Zephyr.
Usage with Zephyr
*****************
How to use this module with Zephyr. Provide all the details.
Reference
*********
External references and links.

10
doc/develop/manifest/index.rst
View File

@ -53,6 +53,12 @@ file which includes them. See :ref:`west-manifest-import` for information on
recommended ways to do this while still inheriting the mandatory modules from
Zephyr's :file:`west.yml`.
.. rst-class:: rst-columns
Use the template :file:`doc/develop/manifest/external/external.rst.tmpl` to add
external modules to the list below:
- TBD
.. toctree::
:titlesonly:
:maxdepth: 1
:glob:
external/*