[Python-ideas] docs.python.org: Short URLs

Nick Coghlan ncoghlan at gmail.com
Mon Feb 17 23:52:23 CET 2014


On 18 Feb 2014 04:39, "Andrew Barnert" <abarnert at yahoo.com> wrote:
>
>
> That being said, there might be a good middle ground--a page that had
just the docs on str, rather than on all builtin types, might be handy. But
other than that one page on all of the builtin types, I can't think of any
others that are overly large...

That's the main one, although some of the module docs jam a tutorial,
reference and cookbook into one page, which can be a bit overwhelming. The
trick lies in figuring out how to split it up without breaking any existing
deep links.

I actually wonder if there might be a benefit in having Sphinx generate a
full "index" URL subtree, where each of those pages links back to the
relevant anchors in the existing docs. That would be potentially useful in
its own right (as a short hand for "here's all the places that provide info
about str"), as well as potentially helping with SEO.

Cheers,
Nick.

>
> _______________________________________________
> Python-ideas mailing list
> Python-ideas at python.org
> https://mail.python.org/mailman/listinfo/python-ideas
> Code of Conduct: http://python.org/psf/codeofconduct/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-ideas/attachments/20140218/c105cef9/attachment.html>


More information about the Python-ideas mailing list