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

Sphinx documentation for opm-simulators and GitHub action #5

Merged
merged 3 commits into from
Jun 12, 2024

Conversation

hakonhagland
Copy link
Collaborator

This was taken from OPM/opm-simulators#5243

@hakonhagland hakonhagland force-pushed the ghaction branch 4 times, most recently from 6b88a86 to 754076e Compare June 10, 2024 19:39
This was taken from PR #5243 in opm-simulators
@lisajulia
Copy link

lisajulia commented Jun 11, 2024

Nice :) Then we can we also include the following from OPM/opm-simulators#5349, right?

  • documentation for opm_embedded
  • documentation for opm common
  • renaming the signature of the functions to this style: opm.simulators.BlackOilSimulator.__init__(deck_filename: str) -> None such that the methods get structured automatically by sphinx

@hakonhagland
Copy link
Collaborator Author

Then we can we also include the following from OPM/opm-simulators#5349, right?

Yes, that is the plan :) Feel free to submit a PR here based on that PR.

@hakonhagland
Copy link
Collaborator Author

@lisajulia If @akva2 does not have any comments, I thinks this PR can be merged?

@lisajulia
Copy link

@lisajulia If @akva2 does not have any comments, I thinks this PR can be merged?

Yes :)

@lisajulia
Copy link

Then we can we also include the following from OPM/opm-simulators#5349, right?

Yes, that is the plan :) Feel free to submit a PR here based on that PR.

Perfect, I'll do that then

@lisajulia
Copy link

@hakonhagland can I merge this then?

@hakonhagland hakonhagland merged commit e25e2e0 into OPM:main Jun 12, 2024
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.

2 participants