Blame doc/that_style/README.md

Packit Service 31306d
# that style
Packit Service 31306d
A plain, more modern HTML style for Doxygen
Packit Service 31306d
Packit Service 31306d
## Requirements
Packit Service 31306d
- Doxygen (tested with version 1.8.13)
Packit Service 31306d
- *optional*: a sass/scss compiler if you want to modify the style
Packit Service 31306d
Packit Service 31306d
## Simple usage
Packit Service 31306d
Tell Doxygen about the files for that style as shown in [doxyfile.conf](doxyfile.conf). You might need to adjust the
Packit Service 31306d
paths depending on where you installed that style.
Packit Service 31306d
When you run Doxygen, all files are copied into to generated HTML folder. So you don't need to keep the originals around
Packit Service 31306d
unless you want to re-generate the documentation.
Packit Service 31306d
Packit Service 31306d
## Advanced
Packit Service 31306d
that style uses a custom javascript to hack some nice stripes into some tables. It has to be loaded from HTML. Hence you need
Packit Service 31306d
to use the provided custom header. Since its default content may change when Doxygen is updated, there might be syntax error in
Packit Service 31306d
the generated HTML. If this is the case, you can remove the custom header (adjust your doxyfile.conf). This has no
Packit Service 31306d
disadvantages other than removing the stripes.
Packit Service 31306d
Packit Service 31306d
[that_style.css](that_style.css) was generated from the scss files in the folder [sass](sass). If you want to change the style,
Packit Service 31306d
use those files in order to have better control. For instance, you can easily change most colors by modifying the variables
Packit Service 31306d
in the beginning of [that_style.scss](sass/that_style.scss).