# Docs & Doxygen

 Markdown documentation is built using `mdbook` and API documentation is built using `doxygen`, and `sphinx`, and `sphinx-markdown-builder`.

 ## Markdown documentation (docs)

 ### Requirements

 The markdown documentation is built using [`mdbook`](https://github.com/rust-lang/mdBook) and [`sphinx`](https://www.sphinx-doc.org/en/master/).

 ### Build command

 If not already installed, be sure to install `sphinx-markdown-builder`.

 ```bash
 pip install sphinx-markdown-builder
 ```

 To build the markdown docs use the `docs` target in CMake.

 ```sh
 cmake -B build
cmake --build build -- docs
```
## API documentation (doxygen)
This is a link to a doxygen autogenerated code reference.
[Doxygen](./doxygen/html/files.html)

 ### Requirements

 The API documentation is built using `doxygen` and `sphinx`, here are the needed tools for building it:

 - [`doxygen`](https://www.doxygen.nl/index.html)
 - [`dot` from `graphviz`](https://graphviz.org/)
 - [`sphinx`](https://www.sphinx-doc.org/en/master/)

### Build command

To build the API docs use the `doxygen` target in CMake

```sh
cmake -B build
cmake --build build -- doxygen
```

### Serving the docs locally

To start a server for local viewing of the docs, after building, run:

```sh
mdbook serve build/docs
```

`mdbook` will start a local server at `http://localhost:3000` with the built docs.