Add template support to sphinx_ext_docstrings.py #17
Conversation
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
- Detect template format (with 'simulators' and 'common_methods' keys) - Expand templates for all defined simulators - Generate documentation for both BlackOil and GasWater simulators - Maintain backward compatibility for flat JSON format - Process escaped newlines in docstrings correctly
This was referenced Aug 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
See OPM/opm-simulators#6075 and OPM/opm-simulators#6418 and OPM/opm-common#4690 for background. We need to add support for a new type of docstrings_simulators.json with template parameter support. This is to avoid documentation duplication between different simulators as described in the referenced PRs.