Update Legacy ResEvap Documentation

[jbatterman]

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

[jbatterman]

@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.

[MikeNeilson]

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]

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]

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]

It's not merged in. But once it is it should show up under "latest".

…

On Mon, Jan 13, 2025, 7:06 AM jbatterman ***@***.***> wrote: Thanks @MikeNeilson <https://github.com/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 ). — Reply to this email directly, view it on GitHub <#878 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB44KCGLQ22EFY4IKDJOT6T2KPJAHAVCNFSM6AAAAABU7FY4UKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKOBXGM2TMMBVG4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[MikeNeilson]

Wait you probbaly mean the actual legacy docs. Open the resevap ingo you can see and scroll down and click one of the links. Somehow it's not in the regular legacy section.

…

On Mon, Jan 13, 2025, 7:28 AM Mike Neilson ***@***.***> wrote: It's not merged in. But once it is it should show up under "latest". On Mon, Jan 13, 2025, 7:06 AM jbatterman ***@***.***> wrote: > Thanks @MikeNeilson <https://github.com/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 > ). > > — > Reply to this email directly, view it on GitHub > <#878 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AB44KCGLQ22EFY4IKDJOT6T2KPJAHAVCNFSM6AAAAABU7FY4UKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKOBXGM2TMMBVG4> > . > You are receiving this because you were mentioned.Message ID: > ***@***.***> >

[jbatterman]

The legacy documentation has too many errors so it will not be included in the main read-the-docs for OpenDCS, but they will be linked there and we can replace that link with the actual documentation once it's updated:
https://opendcs-env.readthedocs.io/en/latest/reservoir-evaporation-algorithm.html