Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Updated Readme + Setup.py for PyPa#16626
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Is there anyway to check how pypi is going to interpret the updated strings (short of releasing as seeing what it does)? |
Uh oh!
There was an error while loading.Please reload this page.
story645 commentedMar 2, 2020 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
@tacaswell apparently yes:https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup
ETA1 I think I'm accidentally gonna learn about packaging 😅
Now to figure out how to automate that 😓 |
updated project urls + longdescription to readmecomposed images from front page into one image for readmeUpdated readme for PyPa:* Updated language to match copy onhttps://matplotlib.org/devdocs/* Added logo + front page images* removed link to developer notes since ended up not using that* removed link to gitwash generated docs since they're not very good* used python -mpytest language since it's more robust* updated testing link and shortened to one option* moved contact down 'cause on pypa that information is in the sidebar & for other folks reading the readme they're probably looking for contributionsCo-Authored-By: Thomas A Caswell <tcaswell@gmail.com>updated classifiers+ changed discourse to forum
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
I'm going to merge this and then manually do the backport so I can (finally) get the 3.2.0 tag done. |
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon! If these instruction are inaccurate, feel free tosuggest an improvement. |
I have done the backport locally, will push soon. |
Merge pull request#16626 from story645/readmeDOC/BLD: Updated Readme + Setup.py for PyPaConflicts:README.rst - implicitly backported several other changes to readme
Manually backported via65a35ef |
Uh oh!
There was an error while loading.Please reload this page.
PR Summary
PyPI will render readmes written inplaintext, markdown or rst , so wanted to take advantage of that since the current mpl page is kind of sparse:https://pypi.org/project/matplotlib/
While updating the readme & setup.py for pictures (logo and a grainy version of the frontpage quartet - would love some help here to improve it), I also added the discourse and funding links in setup.py (project urls are fluid & updated some of the readme links 'cause the old references had been moved. Also shortened and moved around some content to try and make the readme a bit concise.
This is also sort of a model for what packages should do if#16592 goes in.