Skip to content

Add tables pip package to docs requirements #137

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

Merged
merged 4 commits into from
Mar 12, 2024
Merged

Conversation

niksirbi
Copy link
Member

@niksirbi niksirbi commented Mar 12, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

All the CI tests (including Build Sphinx Docs) were passing on PR 116, but Build Sphinx Docs failed after merging to main.

I suspected that this was due to PR 133 which was merged just ahead of PR 116. Here's what I think happened:

Because we switched to requiring pandas from pandas[hdf5], there was no longer a declared pip dependency on tables. This is not a problem for users or during tests, because of the conda install pytables which is run ahead of the pip install. However, only pip install steps are run during the docs build, so the GitHub runner that executes Build Sphinx Docs doesn't install tables.

What does this PR do?

It adds tables as a pip dependency to thedocs/requirements.txt.
Alternatively, we could have added it as a "normal" dependency in pyproject.toml or switched back to pandas[hdf5]. Not sure which one is best. All of them would fix this problem (assuming I've diagnosed it correctly).

No conda install pytables is required here, because the Build Sphinx Docs action runs in an Ubuntu runner, which should come with HDF5 libraries pre-installed.

References

#116
#133

How has this PR been tested?

Yes, locally and in the CI of this PR.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

No.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

Copy link

codecov bot commented Mar 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.28%. Comparing base (cf312d2) to head (56c9905).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #137   +/-   ##
=======================================
  Coverage   99.28%   99.28%           
=======================================
  Files           9        9           
  Lines         556      556           
=======================================
  Hits          552      552           
  Misses          4        4           

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

@niksirbi niksirbi changed the title Fix failing sphinx-gallery example Add tables pip package to docs requirements Mar 12, 2024
@niksirbi niksirbi marked this pull request as ready for review March 12, 2024 14:31
@niksirbi niksirbi requested a review from lochhh March 12, 2024 14:33
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Collaborator

@lochhh lochhh left a comment

Choose a reason for hiding this comment

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

🚀

@lochhh lochhh merged commit a1afeef into main Mar 12, 2024
@lochhh lochhh deleted the fix-filter-example branch March 12, 2024 14:55
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.

2 participants