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

Fix to readthedocs builds #336

Merged
merged 2 commits into from
Sep 11, 2023

Conversation

freemansw1
Copy link
Member

Resolves an issue with readthedocs builds discovered with #335.

We, incidentally, talked about this today. See: https://blog.readthedocs.com/drop-support-system-packages/ . While we had to deal with some of the consequences of this earlier, we now have the new issue of system_packages: true in our readthedocs config, breaking readthedocs builds. This PR should alleviate that issue.

In my mind, this is now a blocking PR, and 1.5.1 shouldn't be released until this is merged or the issue is resolved in some other way.

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@codecov
Copy link

codecov bot commented Sep 8, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (a23a220) 55.74% compared to head (0fab557) 55.74%.

Additional details and impacted files
@@               Coverage Diff               @@
##           RC_v1.5_hotfix     #336   +/-   ##
===============================================
  Coverage           55.74%   55.74%           
===============================================
  Files                  15       15           
  Lines                3310     3310           
===============================================
  Hits                 1845     1845           
  Misses               1465     1465           
Flag Coverage Δ
unittests 55.74% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@w-k-jones w-k-jones 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, readthedocs is also generating properly including the API references. I agree this should be part of v1.5.1 release

@w-k-jones w-k-jones added documentation Updates and improvements to documentation and examples bug Code that is failing or producing the wrong result labels Sep 8, 2023
@w-k-jones
Copy link
Member

Given that this is definitely working, I'm happy for this to be merged with a single review if you are @freemansw1

@freemansw1 freemansw1 added this to the Version 1.5.1 milestone Sep 11, 2023
@freemansw1 freemansw1 merged commit 0a695fc into tobac-project:RC_v1.5_hotfix Sep 11, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Code that is failing or producing the wrong result documentation Updates and improvements to documentation and examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants