23 lines
775 B
Markdown
23 lines
775 B
Markdown
# Doxygen documentation
|
|
|
|
This directory contains the files needed to generate the documentation of MapLibre Native Core using [Doxygen](https://www.doxygen.nl).
|
|
|
|
[Doxygen Awesome](https://jothepro.github.io/doxygen-awesome-css/index.html) is used as a theme and is included as a submodule. To update, simply check out a new version of the submodule.
|
|
|
|
The `[MAINPAGE.md](./MAINPAGE.md)` file contains the contents of the first page you see when you open the documentation website. While `[footer.html](./footer.html)` contains the contents of the footer.
|
|
|
|
To generate the documentation, run
|
|
|
|
```
|
|
doxygen
|
|
```
|
|
|
|
in this directory.
|
|
|
|
While working on the documentation you might find it useful to run a file server. For example, you can use:
|
|
|
|
```
|
|
cd html
|
|
python -m http.server
|
|
```
|