[PYTHON DOC-SIG] Hacking relentlessly :-)
Daniel Larsson
dlarsson@sw.seisy.abb.se
Thu, 20 Feb 1997 00:03:28 +0100
------------39545E9334D49
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset=us-ascii
Mark Hammond wrote:
>
> Ive added cross-references in the text. I dont know what syntax to
> use. My current hacks allow docstrings such as:
> "See also @a.b.c@", and "a.b.c" will be translated into a hyperlink
> if such an object has been collected in this run, else into Bold.
>
> What syntax should I use for this? I thought of a regex that
> dectected _any_ "a.b.c", but in some cases, the link will be a single
> word - ie, no "." sep'd.
Originally, I had a syntax for doing this, but I removed it. I always
made the link, however, regardless of whether the source was collected
or not. Why did you decide to skip the link if it wasn't collected?
Presumably to avoid having dead links, but that also means you have to
"collect" possibly a lot of files in one run.
> Also, I noticed that manpage.py did _not_ process markups or internal
> hyperlinks for list definitions, etc - only paragraphs. Is there a
> reason for this? Having markups and links in definition lists seems
> pretty logical to me...
Ooops, yes of course that's logical. Stupid darn mistake of mine.
While on the gendoc thread: I usually run gendoc on everything in the
standard distribution to put up docs for people in my department. I
thought of adding an option to "collect" every module (and package)
along the sys.path. Comments?
-- Daniel Larsson, ABB Industrial Systems AB
------------39545E9334D49
Content-Transfer-Encoding: 7bit
Content-Type: text/html; charset=us-ascii
<HTML><BODY>
<DT>Mark Hammond wrote:</DT>
<DT>></DT>
<DT> > Ive added cross-references in the text. I dont know
what syntax to</DT>
<DT>> use. My current hacks allow docstrings such as:</DT>
<DT>> "See also @a.b.c@", and "a.b.c" will be translated
into a hyperlink</DT>
<DT>> if such an object has been collected in this run, else into Bold.</DT>
<DT>></DT>
<DT>> What syntax should I use for this? I thought of a regex
that</DT>
<DT>> dectected _any_ "a.b.c", but in some cases, the link
will be a single</DT>
<DT>> word - ie, no "." sep'd.</DT>
<DT> </DT>
<DT>Originally, I had a syntax for doing this, but I removed it. I always
made the link, however, regardless of whether the source was collected
or not. Why did you decide to skip the link if it wasn't collected?
Presumably to avoid having dead links, but that also means you have
to "collect" possibly a lot of files in one run. </DT>
<DT> </DT>
<DT>> Also, I noticed that manpage.py did _not_ process markups or internal</DT>
<DT>> hyperlinks for list definitions, etc - only paragraphs.
Is there a</DT>
<DT>> reason for this? Having markups and links in definition
lists seems</DT>
<DT>> pretty logical to me...</DT>
<DT> </DT>
<DT>Ooops, yes of course that's logical. Stupid darn mistake of mine.</DT>
<DT> </DT>
<DT>While on the gendoc thread: I usually run gendoc on everything in the
standard distribution to put up docs for people in my department. I thought
of adding an option to "collect" every module (and package)
along the sys.path. Comments?</DT>
<DT> </DT>
<DT>-- Daniel Larsson, ABB Industrial Systems AB</DT>
</BODY>
</HTML>
------------39545E9334D49--
_______________
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
_______________