michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add a toctree with reference material

Browse source 
Add a new toctree with reference material, including:

- API docs (Doxygen)
- Kconfig options
- Devicetree bindings

Note that the toctree is rendered manually due to the limitations Sphinx
has when it comes to including relative URLs. Hardcoding absolute URLs
in toctrees is possible, but that means we'd need to update the toctree
on every release (to point to /version/ URL), and downstream users of
the documentation would have to manually patch the toctree with their
own URL. In order to make local builds work, version prefix is only
added if publish tag is provided.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-10-28 18:57:20 +02:00 • committed by Carles Cufí
commit b4f968cf9d
4 changed files with 21 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/index.rst
View file

@ -117,7 +117,6 @@ Sections
Indices and Tables
******************
* :ref:`configuration_options`
* :ref:`glossary`
* :ref:`genindex`