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

doc: west: Do not fail doc build if west not used 

In case west is not present or was not used to initialize the local
zephyr repository, avoid failing the documentation build by including a
placeholder file.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2019-01-27 17:52:43 +01:00 committed by Carles Cufí
parent 0fa1db9416
commit 6162e93a00
3 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/tools/west/flash-debug.rst
View File

@ -246,10 +246,8 @@ upstream Zephyr, the runner should be added into a new or existing
changes break existing test cases, CI testing on upstream pull
requests will fail.
API Documentation for the ``runners.core`` module follows.
.. automodule:: runners.core
:members:
API Documentation for the ``runners.core`` module can be found in
:ref:`west-apis`.
Doing it By Hand
****************

2
doc/tools/west/west-apis.rst
View File

@ -5,4 +5,6 @@
West APIs
#########
.. automodule:: runners.core
:members:

10
doc/tools/west/west-not-found.rst Normal file
View File

@ -0,0 +1,10 @@
:orphan:
.. _west-apis:
West APIs
#########
The west APIs are not documented since either west was missing or the zephyr
repository was not initialized using west during the documentation build.