1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
# DOLFINx C++ interface documentation
The C++ API documentation is generated from the source code using
[Doxygen](https://www.doxygen.nl/), and the Doxygen output is curated
and rendered using reStructured text with
[Sphinx](https://www.sphinx-doc.org/) and
[Breathe](https://breathe.readthedocs.io/).
## Requirements
- [Doxygen](https://www.doxygen.nl/)
- [Sphinx](https://www.sphinx-doc.org/)
- [Breathe](https://breathe.readthedocs.io/)
## Building
```bash
> doxygen Doxyfile
> make html
```
Sphinx/Breathe documentation is in `build/html`and the Doxygen generated
HTML is in `html/`.
|
