This repository has been archived by the owner on Dec 20, 2024. It is now read-only.
DOC: Add status badges to README file
#138
Merged
Conversation
This file contains 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
|
Doc failure is unrelated: |
oesteban
reviewed
Mar 22, 2024
Add miscellaneous status badges to `README` file: - License - PyPI version - Documentation - Python package
jhlegarreta
force-pushed
the
AddMiscStatusBadgesToREADME
branch
from
38dc24a to
4a66668
Compare
|
Doc failure is again unrelated: cross-ref #138 (comment) |
I believe this failure is here to stay -- looks like sphinx was just bumped or similar, but this is complaining that the references are not anymore interpreted as part of the document - we should move them from footnotes (which is how they are interpreted at the moment) into citations (which is what we should do, IMHO). |
Make references in README be considered as citations instead of footnotes. Fixes: ``` Warning, treated as error: /home/runner/work/eddymotion/eddymotion/README.rst:17:Footnote [1] is not referenced. make: *** [Makefile:65: html] Error 2 ``` raised for example in: https://github.com/nipreps/eddymotion/actions/runs/8376155506/job/22935185353?pr=138#step:6:54
|
The error is now another one unrelated to the references: https://github.com/nipreps/eddymotion/actions/runs/8391856943/job/22983140234?pr=138#step:6:54 |
|
#138 (comment) fixed in 6f8bb9a. |
Use commit raw content URL as path to static content in `README`. Fixes: ``` Warning, treated as error: /home/runner/work/eddymotion/eddymotion/README.rst::image file not readable: docs/_static/eddymotion-flowchart.svg make: *** [Makefile:65: html] Error 2 ``` raised for example in: https://github.com/nipreps/eddymotion/actions/runs/8391856943/job/22983140234#step:6:54
jhlegarreta
force-pushed
the
AddMiscStatusBadgesToREADME
branch
from
6f8bb9a to
d3a6b0a
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
READMEfileREADMErefs be considered as citations instead of footnotesREADME