1# nrfx documentation
2
3## Doxygen
4
5You can generate `doxygen` based documentation by running
6
7```shell
8doxygen nrfx.doxyfile
9```
10
11You may want to use the provided scripts `generate_html_doc.sh` or
12`generate_html_doc.bat`. The result can be viewed by opening
13`html/index.html`.
14
15## Sphinx
16
17All the necessary files to compile the Sphinx based documentation for `nrfx`
18are located under `sphinx` folder. As of today the content should match with
19the one produced using `doxygen` only.
20
21### Requirements
22
23You will need to have Python 3 installed as well as some dependencies, which can
24be installed by running:
25
26```shell
27pip install -r requirements.txt
28```
29
30### Build
31
32You may want to use the provided scripts `generate_sphinx_doc.sh` or
33`generate_sphinx_doc.bat`. The result can be viewed by opening
34`html_sphinx/index.html`.
35
36If you want to do it manually you can run the following commands from `doc`
37directory:
38
39```shell
40# compile doxygen documentation (required to generate XML metadata)
41doxygen nrfx.doxyfile
42# compile Sphinx documentation
43sphinx-build -b html sphinx html_sphinx
44```