docs: remove epub from Read the Docs formats#293
Open
GraemeWatt wants to merge 2 commits intomainfrom
Open
Conversation
* Avoids warning fetching Zenodo badge for epub format. * Also remove Sphinx<7 pin and update copyright year.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #293 +/- ##
=======================================
Coverage 92.21% 92.21%
=======================================
Files 5 5
Lines 1118 1118
Branches 237 237
=======================================
Hits 1031 1031
Misses 60 60
Partials 27 27
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I noticed that the Read the Docs build is failing due to a warning building the
epubformat:I get the same warning if I try to build the
epubformat locally. I'm not sure of the reason, but we had a similar problem with rendering a Zenodo badge in the end-to-end tests for the main HEPData repository when using older Chrome versions. I contacted Zenodo support and they explained that they perform blocking based on rate-limiting per IP address, blocking of IP addresses and blocking of User Agent patterns.If we don't need the
epubformat, the simplest solution would be not to build it. I don't see an easy way of excluding the Zenodo badge from theepubformat, but including it for other formats. Sphinx has anonlydirective for reStructuredText files, but the Zenodo badge appears in theREADME.md(Markdown) file.This PR also removes the
Sphinx<7pin fromrequirements.txtas I don't think it is needed, and it updates the copyright year from 2018-2024 to 2018-2026.📚 Documentation preview 📚: https://hepdata-lib--293.org.readthedocs.build/en/293/