In this project we would like to define the API for the ReSParse linear algebra library.
The instruction for generate and verfiy the API are the following
- Install Sphinx
- Add the tool Sphinx-fortran, which is needed for the interpretation of the API from Fortran files
- Clone the repository and compile the documentation via make html
- The documentation can be then opened by a browser in build/html/index.html
- The files to be modified are then of two types:
- reStructured Text ; see for example the file source/index.rst or source/sparsematrix.rst. Here the documentation is presented and referenced from the autodoc generated by
- Fortran files, like for example the file resp.f90. Here the API is directly written in fortran format, such that the objects can be referenced from the .rst files.
A preliminary example of the documentation might be ffound in pdf format in the resp.pdf file, that has been generated by make latexpdf command.