13ac55b5b5
Update nrfx to the recently released version. See https://github.com/NordicSemiconductor/nrfx/blob/v3.4.0/CHANGELOG.md for a list of changes that this version introduces. Origin: nrfx License: BSD 3-Clause URL: https://github.com/NordicSemiconductor/nrfx/tree/v3.4.0 commit: 7c47cc0a56ce44658e6da2458e86cd8783ccc4a2 Purpose: Provide peripheral drivers for Nordic SoCs Maintained-by: External |
||
|---|---|---|
| .. | ||
| buildfiles | ||
| config_dox | ||
| sphinx | ||
| README.md | ||
| drv_supp_matrix.dox | ||
| generate_html_doc.bat | ||
| generate_html_doc.sh | ||
| generate_sphinx_doc.bat | ||
| generate_sphinx_doc.sh | ||
| main_page.dox | ||
| nrf51_series.dox | ||
| nrf91_series.dox | ||
| nrf5340.dox | ||
| nrf52805.dox | ||
| nrf52810.dox | ||
| nrf52820.dox | ||
| nrf52832.dox | ||
| nrf52833.dox | ||
| nrf52840.dox | ||
| nrfx.doxyfile | ||
| nrfx_api.dox | ||
README.md
nrfx documentation
Doxygen
You can generate doxygen based documentation by running
doxygen nrfx.doxyfile
You may want to use the provided scripts generate_html_doc.sh or
generate_html_doc.bat. The result can be viewed by opening
html/index.html.
Sphinx
All the necessary files to compile the Sphinx based documentation for nrfx
are located under sphinx folder. As of today the content should match with
the one produced using doxygen only.
Requirements
You will need to have Python 3 installed as well as some dependencies, which can be installed by running:
pip install -r requirements.txt
Build
You may want to use the provided scripts generate_sphinx_doc.sh or
generate_sphinx_doc.bat. The result can be viewed by opening
html_sphinx/index.html.
If you want to do it manually you can run the following commands from doc
directory:
# compile doxygen documentation (required to generate XML metadata)
doxygen nrfx.doxyfile
# compile Sphinx documentation
sphinx-build -b html sphinx html_sphinx