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