docs: include doxygen-awesome as git submodule

This commit is contained in:
Dirk Olbrich
2024-01-19 11:23:09 +01:00
parent 9f0a781d05
commit 7806dc1d6a
37 changed files with 7 additions and 7401 deletions
+5 -1
View File
@@ -4,7 +4,11 @@ This folder contains the setup to build the IfcOpenShell C++ API documentation f
## Generating the documentation
Prerequisites: make sure to have [Doxygen](https://www.doxygen.nl) and [Graphviz](https://graphviz.org) installed into your `$PATH` variable.
> Prerequisites:
>
> Make sure to have [Doxygen](https://www.doxygen.nl) and [Graphviz](https://graphviz.org) installed into your `$PATH` variable.
>
> The documentation also use the [doxygen-awesome](https://jothepro.github.io/doxygen-awesome-css) theme as a git submodule.
Build with the command (from within the `/docs/cpp-api` folder):