[PYTHON DOC-SIG] Structured documentation syntax

[Robin Friedrich]

|> Date: Thu, 12 Sep 1996 09:42:47 -0400
|> From: Jim Fulton <jim.fulton@digicool.com>
...
|> I like the idea of using []s.
|> 
|> Furthermore, I can see a usage where instead of saying:
|> 
|>    blah blah blah [spam] blah blah 
|> 
|>    ....
|> 
|> .. [spam] http://...
|> 
|> One could say:
|> 
|>    blah blah blah spam [42] blah blah 
|> 
|>    ....
|> 
|> .. [42] http://...
|> 
|> Where "[42]" gets highlighted. Which I would fine more readable 
|> as text and just as readable as hypertext.
|> 
|> It would also be useful to define a URL hierarchy for gendoc
|> and allow relative references in footnotes, so that a doc string could
|> include links to documentation for other objects in the same module 
|> or other modules.  This would also help to reduce HTML dependencies.
|> For example, relative references might work for info files as well.

OK now where getting somewhere. Does anyone volunteer to hack something
up to try out? ;-)

=================
DOC-SIG  - SIG for the Python Documentation Project

send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
=================