On 24 Feb 2014 07:48, "Marcus Smith" <qwcode@gmail.com> wrote:
>>
>>
>> However, after thinking a little more on the challenge, I believe the
>> lower level legacy content should fit right in as a new subsection in
>> the distutils docs at http://docs.python.org/3/distutils/index.html.
>
>
> There's 3 things right now:
>
> 1. http://docs.python.org/3/distutils/index.html ("Installing Python Modules")
> 2. http://docs.python.org/3/install/index.html ("Distributing Python Modules")
> 3. http://docs.python.org/3/library/distutils.html ("28.15. distutils")
>
> I was thinking that #1 and #2 should disappear (or just provide a link to the PUG).
> I don't think you should bother to recreate any more guides in the python.org docs.
> The valuable "reference" content in #1 and #2 should be refactored into #3.
I'd like to keep 1 & 2, but in the form of a high level introduction to their respective areas, including the difference between the standard library and third party modules, and the role redistributors play in the Python ecosystem. Aside from the fact I think that information is useful to end users, and needs to be conveyed in the official docs to give it the necessary authority, my other rationale for that is that I would like to keep the respective links in the top level overview page for the Python docs, as well as avoid breaking any existing deep links to those pages. It also ensures we have at least basic documentation in the offline help files.
> I'm willing to work on a patch for this, if you agree.
I do like the idea of moving most of the distutils docs into the distutils module reference.
If you were willing to handle that task, that would be brilliant - I'd then focus on writing *new* content for the installation and distribution overview pages that introduces open source development principles, PyPI, the Python Packaging Authority and the Python Packaging User Guide.
Cheers,
Nick.
>