wg21-linear-algebra / matrix

A matrix implementation for standardisation by wg21
0 stars 1 forks source link

Add Documentation generation and upload to github pages #3

Open Twon opened 7 months ago

hatcat commented 6 months ago

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

hatcat commented 6 months ago

I guess most of this would go in the wiki.

Twon commented 6 months ago

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: