niksirbi commented 3 months ago

Description

What is this PR

[x] 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:

[x] 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

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #137 +/- ## ======================================= Coverage 99.28% 99.28% ======================================= Files 9 9 Lines 556 556 ======================================= Hits 552 552 Misses 4 4 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.