Skip to content
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

docs: ✏️ fix images on pypi #1310

Merged
merged 3 commits into from
Sep 11, 2023

Conversation

odulcy-mindee
Copy link
Collaborator

@odulcy-mindee odulcy-mindee commented Sep 11, 2023

Attempt to fix #783

@felixdittrich92 Unfortunately, your previous fix failed because it's a link to an asset in a GitHub Release, which behaves differently than https://raw.githubusercontent.com/.... GitHub Release seems to always return an answer with content-type=application/octet-stream, which fools PyPi. Let's try by putting the file directly in the repo.

Also, I re-added pip install at the top of the README.md, I think it makes sense to have it on top to show it's (now) easy to install an up-to-date version of docTR. This point is open to discussion, of course.

@odulcy-mindee odulcy-mindee marked this pull request as ready for review September 11, 2023 12:06
@codecov
Copy link

codecov bot commented Sep 11, 2023

Codecov Report

Merging #1310 (a8f336e) into main (75bddfc) will decrease coverage by 0.02%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1310      +/-   ##
==========================================
- Coverage   95.76%   95.75%   -0.02%     
==========================================
  Files         154      154              
  Lines        6902     6902              
==========================================
- Hits         6610     6609       -1     
- Misses        292      293       +1     
Flag Coverage Δ
unittests 95.75% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

Copy link
Contributor

@felixT2K felixT2K left a comment

Choose a reason for hiding this comment

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

Hey @odulcy-mindee 👋🏼,

thanks for the fix.
I have always tried to avoid exactly this case because with each installation you will also download the images 😅
But at the end i think without uploading the images to a file server we have no chance to fix this unfortunately :/
(In short i agree that the only way is to keep the images in a docs folder just a few style changes please 👍🏼 )

.github/ISSUE_TEMPLATE/bug_report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yml Show resolved Hide resolved
README.md Show resolved Hide resolved
notebooks/README.rst Show resolved Hide resolved
@odulcy-mindee
Copy link
Collaborator Author

I have always tried to avoid exactly this case because with each installation you will also download the images 😅

Using a git-clone, yes :/
But for PyPi, it's fine

@felixT2K
Copy link
Contributor

I have always tried to avoid exactly this case because with each installation you will also download the images 😅

Using a git-clone, yes :/ But for PyPi, it's fine

Yes, sorry, it was probably a bit unclear 😅

@felixdittrich92 felixdittrich92 added this to the 0.7.1 milestone Sep 11, 2023
@felixdittrich92 felixdittrich92 added topic: documentation Improvements or additions to documentation type: misc Miscellaneous ext: docs Related to docs folder labels Sep 11, 2023
Copy link
Contributor

@felixdittrich92 felixdittrich92 left a comment

Choose a reason for hiding this comment

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

Thanks ☺️

@odulcy-mindee odulcy-mindee merged commit 7ab0ece into mindee:main Sep 11, 2023
57 of 58 checks passed
@odulcy-mindee odulcy-mindee deleted the fix_pypi_images branch September 11, 2023 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ext: docs Related to docs folder topic: documentation Improvements or additions to documentation type: misc Miscellaneous
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Images not displayed on the PyPi page.
3 participants