[Doc-SIG] [Python-Dev] The docs, reloaded

Aahz aahz at pythoncraft.com
Tue May 22 03:02:34 CEST 2007


On Mon, May 21, 2007, Georg Brandl wrote:
> Aahz schrieb:
>> 
>> * Your version creates only a single page for documenting a module; this
>> is most notable with docs for modules that used to have multiple pages,
>> such as ``re``.  Compare
>> http://pydoc.gbrandl.de/modules/re.html
>> with
>> http://docs.python.org/lib/module-re.html
>> There are advantages to the single-page approach, but you should at least
>> change it to include a top-of-page ToC.
> 
> The TOC is there, in the left sidebar.

Gotcha.  That's being done with CSS.  Normally, I don't have a problem
with that, but I think for this work the ToC should go at the top of the
source.
-- 
Aahz (aahz at pythoncraft.com)           <*>         http://www.pythoncraft.com/

"Look, it's your affair if you want to play with five people, but don't
go calling it doubles."  --John Cleese anticipates Usenet


More information about the Doc-SIG mailing list