search

trilinos / Trilinos

Primary repository for the Trilinos Project
https://trilinos.org/
Other
1.18k stars 559 forks source link

Update Request for Online Documentation #13189

Open avfav1235 opened 4 days ago

avfav1235 commented 4 days ago

Dear Trilinos Team,

I am currently a student exploring the Trilinos library for HPC finite element simulations. And I’m particularly interested in the heterogeneous Tpetra and Kokkos modules and MueLu.

However, I have encountered an issue with the accessibility of updated documentation. It appears that many of the tutorials and pdfs available on the official website are outdated, and the dev version of official Doxygen page is also outdated (most packages last updated before 2020).

For example, I was looking for information on the Tpetra::FECrsMatrix class. While I can see references to this module in the GitHub repository, it is absent from Tpetra’s official Doxygen documentation, which has not been refreshed since 2021. After extensive searching, I did find some useful resources to learn, but an updated documentation page would greatly help in accessing the latest APIs and documentations.

Thanks again for this amazing library.

cgcgcg commented 4 days ago

@trilinos/tpetra From what I can tell the doxygen does get regenerated on master merge. Last time was a week ago. But I don't see the FECrsMatrix either, so something isn't right.

cgcgcg commented 4 days ago

@avfav1235 Where do you see that the Tpetra doxygen has not been refreshed since 2021? The bottom of the page that you linked claims "Generated on Fri Jun 28 2024 09:19:10".

avfav1235 commented 4 days ago

@avfav1235 Where do you see that the Tpetra doxygen has not been refreshed since 2021? The bottom of the page that you linked claims "Generated on Fri Jun 28 2024 09:19:10".

I apologize for the confusion, it seems I made a mistake. I (incorrectly) assumed that the "Last modified" date on this page represented the last time the entire folder (and all its contents) was modified, which appears not to be the case.

Regarding the original issue, the Tpetra doxygen site does list the FECrsMatrix hpp files. However, the FECrsMatrix class cannot be found.

csiefer2 commented 3 days ago

@avfav1235 I don't know quite that's going on here. When I run Doxygen by hand, it claims to generate the docs for the FECrsMatrix class... but it doesn't.