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

Update Legacy ResEvap Documentation #878

Open
jbatterman opened this issue Jan 10, 2025 · 6 comments · Fixed by #879
Open

Update Legacy ResEvap Documentation #878

jbatterman opened this issue Jan 10, 2025 · 6 comments · Fixed by #879
Assignees

Comments

@jbatterman
Copy link
Collaborator

Update legacy ResEvap documentation to add enhancements that have been added by RMA and documentation on the new ResEvap algorithm.

@jbatterman
Copy link
Collaborator Author

@oskarhurst do you have any documentation on the ResEvap algorithm you can share with RMA to help with this? Also please update this issue with a comment after discussing with @MikeNeilson why the documentation does not live on the main readthedocs website. It seems to be on its own branch right now.

@jbatterman jbatterman moved this from Todo to In Progress in ResEvap CCP Compute Jan 10, 2025
@MikeNeilson
Copy link
Contributor

I'll have to investigate. I know the documentation was added to the system, but another user reported issues with some links changing so I suspect an issue with the documentation due to the branching changes that wasn't correctly accounted for.

@MikeNeilson MikeNeilson linked a pull request Jan 13, 2025 that will close this issue
6 tasks
@MikeNeilson
Copy link
Contributor

Yep, read the docs made some changes, which I did get an email about but it just didn't click, and it broke the build of docs on read the docs itself. Once the required changes were implemented it looks like it works.

That said the conversion of the legacy docs wasn't great (it never is) and there's a lot of errors. It renders but there's likely various missing tables due to how picky reStructure text is about the table formats.

See #879 for the actual changes.

@jbatterman
Copy link
Collaborator Author

Thanks @MikeNeilson. I agree we have some work to do with updating the Legacy documentation and that's part of what this issue will address. I still can't seem to navigate to find it from the main read the docs link - can you help me find that? Seems like the original link still works (https://opendcs-env--791.org.readthedocs.build/en/791/reservoir-evaporation-algorithm.html).

@MikeNeilson
Copy link
Contributor

MikeNeilson commented Jan 13, 2025 via email

@MikeNeilson
Copy link
Contributor

MikeNeilson commented Jan 13, 2025 via email

@github-project-automation github-project-automation bot moved this from In Progress to Done in ResEvap CCP Compute Jan 13, 2025
@jbatterman jbatterman reopened this Jan 13, 2025
@jbatterman jbatterman moved this from Done to In Progress in ResEvap CCP Compute Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

3 participants