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

Prevent notebooks from being executed on ReadTheDocs build #122

Merged
merged 2 commits into from
May 31, 2024

Conversation

lbianchi-lbl
Copy link
Contributor

@lbianchi-lbl lbianchi-lbl commented May 30, 2024

  • 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 lbianchi-lbl added the Priority:High High Priority Issue or PR label May 30, 2024
@lbianchi-lbl lbianchi-lbl self-assigned this May 30, 2024
@lbianchi-lbl lbianchi-lbl changed the title Prevent notebooks from being run on ReadTheDocs build Prevent notebooks from being executed on ReadTheDocs build May 30, 2024
@lbianchi-lbl lbianchi-lbl marked this pull request as ready for review May 30, 2024 22:54
@lbianchi-lbl
Copy link
Contributor Author

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

Copy link
Member

@andrewlee94 andrewlee94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@lbianchi-lbl
Copy link
Contributor Author

lbianchi-lbl commented May 31, 2024

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
Copy link
Member

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

@JavalVyas2000
Copy link
Contributor

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

@AlexNoring
Copy link
Contributor

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

@lbianchi-lbl lbianchi-lbl merged commit 9f18594 into IDAES:main May 31, 2024
8 checks passed
@lbianchi-lbl lbianchi-lbl deleted the rtd-no-build branch May 31, 2024 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority:High High Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Helmholtz EoS external functions not available in NGCC Example Initial tutorial loads with no solver
4 participants