Open Twon opened 7 months ago
I guess most of this would go in the wiki.
The plan is to automatically generate documentation and upload it to the project's respective Github pages. We can use Doxygen to generate tags from the code, and then use Sphinx to generate the HTML from mdfiles controlling the structure of the document as we want it. This is the approach used by fmt
and the mp-unit
projects currently. Take a look at how this may look:
MPUnits:
Documentation list
Public API
Implementation and maintenance
Tutorials
Geometry and Givens matrices
Dynamically expanding matrix (new row data at run time)
Integrating mdspan
Replacement algorithms
Units