Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add available problems and their runtime parameters to the docs #269

Merged
merged 11 commits into from
Sep 15, 2024

Conversation

zingale
Copy link
Collaborator

@zingale zingale commented Sep 14, 2024

this adds a script to the build process to generate the problem definitions.
This also fixes a bunch of docs errors and makes the solver pages more consistent

@zingale zingale changed the title [WIP] add available problems and their runtime parameters to the docs add available problems and their runtime parameters to the docs Sep 15, 2024
@zingale
Copy link
Collaborator Author

zingale commented Sep 15, 2024

This works now and fixes a lot of doc build errors.
The main task now is to add module-level docstrings to the prolbem setups.

@zingale zingale merged commit 903285e into python-hydro:main Sep 15, 2024
13 checks passed
@zingale zingale deleted the doc_probs branch September 15, 2024 00:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant