Prevent notebooks from being executed on ReadTheDocs build

lbianchi-lbl commented 1 month ago

Prior to this PR, the command being used in .readthedocs.yaml caused the notebooks to be executed on the ReadTheDocs runner prior to the HTML build taking place
This caused many issues including:
- Errors being shown in the rendered notebooks, as many requirements are missing in that environment (e.g. idaes get-extensions)
- RTD builds taking a long time
- Rendered notebooks looking different from the version committed to Git

115 Before

2024-05-30_17-34

115 After

2024-05-30_17-35

121 Before

2024-05-30_17-52

121 After

2024-05-30_17-52_1

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

📚 Documentation preview 📚: https://idaes-examples--122.org.readthedocs.build/en/122/

lbianchi-lbl commented 1 month ago

@TimBartholomew @AlexNoring if you have a second, please verify that the issue you reported (#115 and #121 respectively) are resolved by this PR. You can use the following link for a preview build: https://idaes-examples--122.org.readthedocs.build/en/122/

lbianchi-lbl commented 1 month ago

Looks good to me.

My only question is what the warning messages about the Helmholtz functions in one of the new outputs were (in case there was something there that needed to be addressed). Unfortunately the output got cut off in the screenshot.

@andrewlee94 you should be able to browse the preview build for the section corresponding to that screenshot: https://idaes-examples--122.org.readthedocs.build/en/122/active/power_gen/ngcc/ngcc_doc.html#create-the-ngcc-model

Would it make sense to create a dedicated issue to track that?

andrewlee94 commented 1 month ago

OK - that is not something to fix here. I think @JavalVyas2000 is already working on fixing this in another PR.

JavalVyas2000 commented 1 month ago

@andrewlee94, I am working on the NGCC example and subsequently on the Helmholtz functions EoS warnings as well.

AlexNoring commented 1 month ago

@lbianchi-lbl Yes, this resolves issue #121.

IDAES / examples