search

ROCm / rocALUTION

Next generation library for iterative sparse solvers for ROCm platform
https://rocm.docs.amd.com/projects/rocALUTION/en/latest/
MIT License
74 stars 38 forks source link

refactor rocALUTION documentation #211

Closed SwRaw closed 4 months ago

SwRaw commented 5 months ago

Refactoring all libraries to adhere to the documentation standards that includes following home page format, index style, language improvements, link fixes, navigation, and overall content readability improvements.

SwRaw commented 5 months ago

There is a lot of repetition of API content. As we call the same doxyfunction at many places. The solvers and preconditioners are individual files while being a part of API as well. I tried to remove the solvers and preconditioners from API library with a reference to the respective file but then realized that there are many cross-references to the solvers/preconditioners in the API library. Removing these would lead to many broken links so I am keeping them. I still feel the entire documentation needs a lot of rework to remove/reduce redundant content. Instead of calling the doxyfunction, call them at one place and add links to all other places where they are needed.

SwRaw commented 5 months ago

@lpaoletti Please review.

jsandham commented 4 months ago

This is a great start. Approved.