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 gha #5349

Closed
wants to merge 10 commits into from
Closed

Sphinx gha #5349

wants to merge 10 commits into from

Conversation

lisajulia
Copy link
Contributor

Based on #5243, which should be merged first.
Furthermore includes:

  • Add documentation for the Python bindings from opm-common
  • Add documentation for opm_embedded

@lisajulia
Copy link
Contributor Author

jenkins buil this opm-common=4018 please

@lisajulia
Copy link
Contributor Author

lisajulia commented May 15, 2024

I'm currently still working on these two issues:

@lisajulia lisajulia closed this May 15, 2024
@lisajulia lisajulia reopened this May 15, 2024
@lisajulia lisajulia force-pushed the sphinx_gha branch 2 times, most recently from db4d77b to db2ddc8 Compare May 16, 2024 13:49
@lisajulia
Copy link
Contributor Author

lisajulia commented May 17, 2024

I'm currently still working on these two issues:

* The way of making the docstrings_common.json from opm-common available here is not ideal yet, since this file is copied around a lot:
  https://github.com/OPM/opm-common/pull/4018/files#diff-1e7de1ae2d059d21e1dd75d5812d5a34b0222cef273b7c3a2af62eb747f9d20aR477
  https://github.com/OPM/opm-simulators/pull/5349/files#diff-3764531759f1b50aee06cf2267f2ab7508c016a86d776664e4754694fd711bf9R24

* I'm still working on the documentation structure, since now all methods of all classes from opm-common are listed under "common" but actually they should be grouped

For the first issue:

For the second issue: The methods are grouped now, but there is still room for improvement

@lisajulia
Copy link
Contributor Author

Almost done, now I still need to change the Poetry build scripts to take the docstrings_common.json from here and not trigger a commit in opm-simulators.

Current state:
A workflow here is triggered when docstrings_common.json is changed in opm-common, the docstrings_common.json then gets updated here and the documentation is rebuilt.

@lisajulia lisajulia force-pushed the sphinx_gha branch 3 times, most recently from d3ea6c9 to 1f76daa Compare June 26, 2024 05:13
@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the sphinx_gha branch 2 times, most recently from 692e881 to 50c8430 Compare June 26, 2024 05:40
@lisajulia
Copy link
Contributor Author

jenkins build this opm-common=4018 please

1 similar comment
@lisajulia
Copy link
Contributor Author

jenkins build this opm-common=4018 please

@lisajulia
Copy link
Contributor Author

@hakonhagland and @blattms this is also ready for review, finally!

@hakonhagland
Copy link
Contributor

This looks good to me. Great that you managed to use GitHub actions in opm-common to trigger the sphinx build workflow in opm-simulators, hope this can be activated and tested in practice soon 😄

@hakonhagland
Copy link
Contributor

hope this can be activated and tested in practice soon

@atgeirr Can you have a look at #5243 (which is a prerequisite for this PR)

@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia
Copy link
Contributor Author

For the build here to go through, github actions need read and write permissions:
Can someone check how the permissions are set currently?
Screenshot from 2024-07-02 11-06-51

@lisajulia lisajulia mentioned this pull request Jul 5, 2024
@lisajulia lisajulia force-pushed the sphinx_gha branch 8 times, most recently from d95a180 to 29e6506 Compare July 8, 2024 11:14
@lisajulia lisajulia force-pushed the sphinx_gha branch 5 times, most recently from 81eaf4a to 8260f5a Compare July 9, 2024 12:21
@lisajulia lisajulia mentioned this pull request Jul 11, 2024
@lisajulia lisajulia deleted the sphinx_gha branch July 31, 2024 06:31
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