This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author berker.peksag
Recipients Frédéric Jolliton, Mariatta, PeterLovett, aroberge, azsorkin, belopolsky, berker.peksag, donmez, eric.araujo, ezio.melotti, georg.brandl, lukasz.langa, rhettinger, ron_adam, tritium, vterron
Date 2016-10-03.07:10:44
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1475478644.84.0.438077685608.issue10716@psf.upfronthosting.co.za>
In-reply-to
Content
(As a result of the discussion at http://psf.upfronthosting.co.za/roundup/meta/issue605, I started to re-triage all easy issues.)

I don't think this is a suitable task for new contributors. It requires a) good HTML and CSS knowledge b) familiarity with pydoc API c) possibly design of a new API to finish this task.

There are also some key points that needs to be discussed:

* The current API ties to the dated HTML output and we may not need some of the members in the new format (look at the signature of HTMLDoc.section() for example) Also, I know HTMLDoc is not a public API, but I saw a number of HTMLDoc subclasses in GitHub (even I did it myself in my own projects) so there is a risk of breaking working applications. My suggestion is to keep the old API as-is and create a new one with new output.

* The another question is that do we need HTMLDoc in 2016? Sphinx, sphinx-autodoc and readthedocs.org doing an amazing job and it might be better to refer people to alternative solutions (like we did for requests) See also https://mail.python.org/mailman/private/core-mentorship/2016-August/003622.html for a discussion about this subject.
History
Date User Action Args
2016-10-03 07:10:45berker.peksagsetrecipients: + berker.peksag, georg.brandl, rhettinger, belopolsky, ron_adam, donmez, aroberge, ezio.melotti, eric.araujo, PeterLovett, lukasz.langa, vterron, tritium, azsorkin, Frédéric Jolliton, Mariatta
2016-10-03 07:10:44berker.peksagsetmessageid: <1475478644.84.0.438077685608.issue10716@psf.upfronthosting.co.za>
2016-10-03 07:10:44berker.peksaglinkissue10716 messages
2016-10-03 07:10:44berker.peksagcreate