Repository navigation
Conversation
This is a significant diff on the documentation that attempts to redirect many of the references to other packages, examples, or files. It took a couple passes to get things looking roughly correct. I took a look at the doxygen for Stratimikos here: https://trilinos.github.io/docs/stratimikos/index.html and there were numerous broken links or references to non-existant classes, so it seems this documentation has not been updated in a while. While this may not be perfect, hopefully it is an improvement. Assisted-by: GPT-5.4 Signed-off-by: Zakari Echo <zeckert@sandia.gov>
Reproducing CI builds locallyCI builds can be reproduced locally in a container. Requirements: Python 3.9+, Podman Steps:
|
bartlettroscoe
requested
a balanced review from Copilot
and removed request for
Copilot
November 19, 2026 20:10
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved documentation issues omit the Ifpack2 API, reference an invalid driver input, break Teuchos links, and leave Belos documentation generation instructions incomplete.
4 open issues
What changed in this PR
Updates Stratimikos documentation for the Tpetra-based v18 stack, replacing obsolete Epetra-era examples and adapter references.
Changes:
- Redirects examples and solver documentation to Tpetra, Amesos2, Belos, and Ifpack2.
- Updates Doxygen inputs, example paths, and tag-file configuration.
- Refreshes Belos/Thyra documentation metadata and build guidance.
| File | Description |
|---|---|
packages/stratimikos/doc/TagFiles |
Removes the Belos tag-file include. |
packages/stratimikos/doc/index.doc |
Replaces legacy adapter references and examples with current alternatives. |
packages/stratimikos/doc/groups.doc |
Documents Tpetra examples, command-line options, and test inputs. |
packages/stratimikos/doc/Doxyfile |
Updates adapter inputs, example paths, and the Belos documentation destination. |
packages/stratimikos/doc/BrowserTagFiles |
Removes several package browser-tag includes. |
packages/stratimikos/browser/doc/Doxyfile |
Redirects example lookup to Tpetra examples and Belos tests. |
packages/stratimikos/adapters/belos/doc/README |
Updates the collection description and build-directory guidance. |
packages/stratimikos/adapters/belos/doc/index.doc |
Corrects the included test-source path. |
packages/stratimikos/adapters/belos/doc/Doxyfile |
Updates the Belos collection name and source/output paths. |
Review effort: Max
| PROJECT_NAME = "Belos/Thyra Linear Solver Adapter Software" | ||
| PROJECT_NUMBER = "Version of the Day" | ||
| OUTPUT_DIRECTORY = ../thyra/doc | ||
| OUTPUT_DIRECTORY = ../adapters/belos/doc |
| Trilinos/packages/stratimikos/doc | ||
|
|
||
| (see the file 'build.doxygen.documentation'). | ||
| (see the package documentation build scripts in that directory). |
| ../adapters/ifpack/src \ | ||
| ../adapters/ml/src | ||
| ../adapters/amesos2/src \ | ||
| ../adapters/belos/src |
Comment on lines
+51
to
+54
| The testing program is driven by | ||
| <tt>test_tpetra_stratimikos_solver_driver.cpp</tt> and uses input files such | ||
| as <tt>FourByFour.belos.np.xml</tt>, <tt>TpetraBelosTest.xml</tt>, and | ||
| <tt>stratimikos_BelosPrec_ParameterList.xml</tt>. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

@trilinos/stratimikos
Motivation
We are trying to clean up any remaining Epetra-stack code for the v18 release in a few weeks. The goal is to remove dead code paths that no longer build and remove documentation that discusses support that no longer exists.
Testing
I will get the PR testing passing, but this should be ready for review.
Additional Information
This was assisted by GPT-5.5. This is a significant diff on the documentation that attempts to redirect many of the references to other packages, examples, or files. It took a couple passes to get things looking roughly correct. I took a look at the doxygen for Stratimikos here: https://trilinos.github.io/docs/stratimikos/index.html and there were numerous broken links or references to non-existent classes, so it seems this documentation has not been updated in a while. While this may not be perfect, hopefully it is an improvement.