Add tables pip package to docs requirements #137
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What is this PR
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
frompandas[hdf5]
, there was no longer a declared pip dependency ontables
. This is not a problem for users or during tests, because of theconda 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 installtables
.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 topandas[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: