Landing pages in docs for standard library packages

[ncoghlan]

BPO	11710
Nosy	@birkenfeld, @ncoghlan, @orsenthil, @ezio-melotti, @merwok

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2012-10-06.11:49:29.013>
created_at = <Date 2011-03-29.12:31:46.475>
labels = ['docs']
title = 'Landing pages in docs for standard library packages'
updated_at = <Date 2012-10-06.11:49:29.011>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2012-10-06.11:49:29.011>
actor = 'python-dev'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2012-10-06.11:49:29.013>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2011-03-29.12:31:46.475>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 11710
keywords = []
message_count = 7.0
messages = ['132481', '132753', '132756', '132758', '132760', '133717', '172186']
nosy_count = 7.0
nosy_names = ['georg.brandl', 'ncoghlan', 'orsenthil', 'ezio.melotti', 'eric.araujo', 'docs@python', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue11710'
versions = ['Python 3.1', 'Python 2.7', 'Python 3.2', 'Python 3.3']

[ncoghlan]

http://docs.python.org/py3k/urllib errors out rather than returning an index page for the modules that are part of the urllib package.

This index page could also link to the HOWTO at http://docs.python.org/py3k/howto/urllib2.html

The following packages have the same problem:
xml, http, xmlrpc, concurrent

These ones look OK:
logging, curses, html, tkinter

These index pages don't necessarily need to be linked from the contents page, but they should exist so that manually typed URLs for these packages do something useful rather than erroring out with a 404.

[merwok]

It works with docs.python.org/py3k/library/urllib

[ncoghlan]

That link goes to a 404 error page for me.

[merwok]

Okay, now I understand your request: a spam package should have a page at library/spam in addition to submodules pages. +1.

[ncoghlan]

Oh, I see the confusion - yeah, the missing "library" in the URL in my first post was just a typo. It was actually present in my test URLs (otherwise the 4 packages with landing pages wouldn't have worked).

The problem in 2.7 is smaller, since there aren't as a many packages - only xml and xmlrpc are missing landing pages in that version.

[ezio-melotti]

The packages without a landing page on 3.2 are:
concurrent
xml
urllib
http
xmlrpc

In the concurrent case the problem could be solved with redirects too, since there's only one module in the package. The other modules could provide a landing page that lists the modules in the package. (Note that the html page only lists html.escape, so the other modules could be added there too.)

[python-dev]

New changeset 1141648fa655 by Georg Brandl in branch '3.3':
Closes bpo-11710: create "landing pages" (/library/package.html) for those packages that have no documented content themselves, e.g. "urllib" or "http".
http://hg.python.org/cpython/rev/1141648fa655