Documentation Generation

Contents

Documentation Generation#

You can use sphinx + doxygen to generate documentation for your project. Doxygen is used to parse C++ code and extract the docstring into a XML. Sphinx with the breathe and exhale extensions parse the XML and generate the documentation as HTML.

Sphinx configuration example
Doxygen configuration example
Read the docs configuration example

Note

You can use the documentation for personal note taking. You will thank your past self.

Plot Palette#

Font Comfortaa
Inspired from Color hunt Palette 252860

Palette#
Name	Hex	RGB	Image
Turquoise	75CFB8	rgb(117, 207, 184)	<svg width=”64” height=”64”><rect width=”64” height=”64” style=”fill:rgb(117, 207, 184)” /></svg>
Light Green	BBDFC8	rgb(187, 223, 200)	<svg width=”64” height=”64”><rect width=”64” height=”64” style=”fill:rgb(187, 223, 200)” /></svg>
Orange	FFC478	rgb(255, 196, 120)	<svg width=”64” height=”64”><rect width=”64” height=”64” style=”fill:rgb(255, 196, 120)” /></svg>
Beige	F0E5D8	rgb(240, 229, 216)	<svg width=”64” height=”64”><rect width=”64” height=”64” style=”fill:rgb(240, 229, 216)” /></svg>
Green	d8f0e5	rgb(216, 240, 229)	<svg width=”64” height=”64”><rect width=”64” height=”64” style=”fill:rgb(216, 240, 229)” /></svg>
Blue	d8e5f0	rgb(216, 229, 240)	<svg width=”64” height=”64”><rect width=”64” height=”64” style=”fill:rgb(216, 229, 240)” /></svg>
Pink	f0d8e5	rgb(240, 216, 229)	<svg width=”64” height=”64”><rect width=”64” height=”64” style=”fill:rgb(240, 216, 229)” /></svg>
Red	F0D8D8	rgb(240, 216, 216)	<svg width=”64” height=”64”><rect width=”64” height=”64” style=”fill:rgb(240, 216, 216)” /></svg>