On Wed, Jan 15, 2014 at 1:30 AM, Nick Coghlan <ncoghlan@gmail.com> wrote:
On 15 Jan 2014 17:15, "Marcus Smith" <qwcode@gmail.com> wrote:
Fyi, the "Python Packaging User Guide" has moved from bitbucket to github.
The new project home is here: https://github.com/pypa/python-packaging-user-guide and the built site is still here: https://python-packaging-user-guide.readthedocs.org/en/latest/
Guess I better make a new clone :)
For those who are interested in helping, a quick survey of the text will show many sections marked up with "FIXME" comments. Although general editing is helpful, I think we mostly need "packaging experts" at this point who are willing to invest the time in filling out and correcting the sections they feel strong on.
As stated in the README, "The guide is part of a larger effort to improve all of the packaging and installation docs, including pip, setuptools, virtualenv, and wheel. Ultimately, users need more than a "guide" to feel confident about the current tools. They need complete, accurate and inter-consistent documentation across all the projects"
I would include docs.python.org in that list. I've already added links from the relevant pages to the user's guide (as even in its current incomplete state it is a better end user resource than the stdlib docs), but ultimately we need to cull the current outdated information from the stdlib docs and actively promote the development of cross-version compatible packages.
Is there a description somewhere of the plan for what packaging-related information will be covered in docs.python.org proper (and the stages for getting there), and which information will be off-loaded to the documentation for the other projects that Marcus mentioned? Will there be any planned overlap? I seem to remember or got the impression from earlier e-mails on the Distutils list that a lot of the information currently in docs.python.org was going to be removed at some point. (Some of it still seems useful by the way, for example by covering things that are still stubs in the PPUG. Also by the way, is that the right acronym for quick reference? :) ). --Chris