Improve documentation #33
Conversation
Link to the Python Packaging User Guide, with caveat that it is a work in progress.
| <p><strong>Warning: </strong>If your project has optional C extensions, it is recommended not to publish a universal wheel, because pip will prefer the wheel over a source installation.</p> | ||
| <h3>C extensions</h3> | ||
| <p>PyPI currently only allows uploading platform-specific wheels for Windows and Mac OS X. It is still useful to create wheels for these platforms, as it avoids the need for your users to compile the package when installing.</p> | ||
| <p>You will need to have access to the platform you are building for.</p> |
There was a problem hiding this comment.
I would like to expand on this with more detail.
| <p>You can also <a href="https://github.com/meshy/pythonwheels/pulls/">submit a pull-request</a>.</p> | ||
| <h2>Other resources</h2> | ||
| <p>The <a href="https://python-packaging-user-guide.readthedocs.org/en/latest/">Python Packaging User Guide</a> is aiming to be the authoritative guide for python packaging and installation. It is still a work in progress, so some information may be missing.</p> | ||
| <p><a href="https://pypip.in/wheel.html">PyPI Pins</a> has a pin you can use to display your wheel compatibility: <img src="https://pypip.in/wheel/blackhole/badge.png" alt="Wheel Status"></p> |
|
Looks good to me - thanks for putting this together! |
Conflicts: index.html
|
This all looks great, @Ian-Foote. Thank-you very much for putting so much effort into this. If it's ok, I would like to ask you to make one change before I merge. Would it be possible to include the link to the "authoritative resource" even more prominently? Specifically, if it could be moved to the bottom of the "What is this list" section, that would be amazing. I'm thinking that the copy should make it absolutely clear that pythonwheels.com is not the official website for python wheels by saying something like:
Thank-you! Charlie. |
|
Yeah, PPUG is already the best available resource - the CPython docs link to it from the disclaimers at the top of the distribution, installation and extension building guides. It also has a a nice new URL at http://packaging.python.org (although the old URL still works) |
|
Great stuff! Thanks! |
Add
Advantages of wheelsandOther Resourcessections. Split information about creating wheels intoPure PythonandC extensionssubsections. Add link to pull-requests on github to encourage more active participation.I have tried to cover the suggestions made in issue #29 by @zzzeek. I have also included suggestions from #22 and #16.