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

Attempt to fix readthedocs build #1105

Merged
merged 17 commits into from
May 16, 2023
Merged

Conversation

daico007
Copy link
Member

PR Summary:

For some reason, the docs build on PR has been failing (for a while). This PR will attempt to find and fix that issue.

PR Checklist


  • Includes appropriate unit test(s)
  • Appropriate docstring(s) are added/updated
  • Code is (approximately) PEP8 compliant
  • Issue(s) raised/addressed?

@daico007 daico007 linked an issue Apr 19, 2023 that may be closed by this pull request
@daico007 daico007 marked this pull request as ready for review May 15, 2023 18:30
@codecov
Copy link

codecov bot commented May 15, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -1.87 ⚠️

Comparison is base (d1c1f33) 86.89% compared to head (fe7965e) 85.02%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1105      +/-   ##
==========================================
- Coverage   86.89%   85.02%   -1.87%     
==========================================
  Files          61       61              
  Lines        6318     6319       +1     
==========================================
- Hits         5490     5373     -117     
- Misses        828      946     +118     
Impacted Files Coverage Δ
mbuild/recipes/__init__.py 100.00% <100.00%> (ø)
mbuild/utils/io.py 83.62% <100.00%> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@daico007
Copy link
Member Author

Ok, I think the docs (somehow) is building correctly now. There were a combinatotiral issue with the fail_on_warning clause in .readthedocs.yml compounded with some deprecated warnings, missing dependencies, etc. But I hand checked the built docs and all pages seems to be built alright (especially those writers which are built from their docstrings). So, I think this PR is ready for review, if you want to have a look at it @chrisiacovella, if not I can merge it either tomorrow or wednesday.

Also, we have an DeprecatedWarnings regading the pkg_resrouces, which is currently used in mbuild/utils/io.py and mbuild/recipes/__init__.py that we might also want to take care of. I will try to poke a round and see what's the updated syntax should be and push it in later.

@daico007 daico007 merged commit b4d2082 into mosdef-hub:main May 16, 2023
15 of 17 checks passed
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.

Readthedocs build fails for PR
1 participant