[PYTHON DOC-SIG] Hacking relentlessly :-)
Daniel Larsson
dlarsson@sw.seisy.abb.se
Thu, 20 Feb 1997 00:10:33 +0100
------------2B107203164210
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset=us-ascii
Mark Hammond wrote:
>
> [You dropped the SIG - was that intentional?]
Nope! I resent my message to the group.
>
> > 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.
>
> Yup - this was the idea. These links are "internal" by definition.
> If they cant be found in the current build, they wont be found later
> :-)
Ok. I sometimes used links to standard classes, but then gendoc assumed
the
resulting HTML files would reside in the same directory.
> Note that _no_ URL is entered. The whole point of these markups is
> for the generater to _deduce_ the URL name, based on the object name.
Yes, I understand that. That's what I did as well.
> IMHO, it should be possible to create a single package with gendoc
> that has _zero_ bad links. This currently is pretty hard :-)
Hmm, true. I insert all kinds of links, such as when you import modules,
inherit from classes, etc. Maybe add YAO (yet another option) to avoid
generating
links to things we're not sure are there (or perhaps the other way
around, an option to generate links regardless if they are seen during
this collect).
> > 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?
>
> Makes sense to me. This is what I do for ni(), so I suppose it is
> pretty similar.
>
> I also added a "-s" option to gendoc, so the skiplist can be added
> to.
>
--
Daniel Larsson, ABB Industrial Systems AB
------------2B107203164210
Content-Transfer-Encoding: 7bit
Content-Type: text/html; charset=us-ascii
<HTML><BODY>
<DT>Mark Hammond wrote:<BR>
> <BR>
> [You dropped the SIG - was that intentional?]</DT>
<DT> </DT>
<DT>Nope! I resent my message to the group.</DT>
<DT><BR>
> <BR>
> > Why did you decide to skip the link if it wasn't collected? Presumably<BR>
> > to<BR>
> > avoid having dead links, but that also means you have to "collect"<BR>
> > possibly<BR>
> > a lot of files in one run.<BR>
> <BR>
> Yup - this was the idea. These links are "internal"
by definition.<BR>
> If they cant be found in the current build, they wont be found later<BR>
> :-)<BR>
<BR></DT>
<DT>Ok. I sometimes used links to standard classes, but then gendoc assumed
the</DT>
<DT>resulting HTML files would reside in the same directory.</DT>
<DT><BR>
> Note that _no_ URL is entered. The whole point of these markups
is<BR>
> for the generater to _deduce_ the URL name, based on the object name.<BR>
<BR></DT>
<DT>Yes, I understand that. That's what I did as well.</DT>
<DT><BR>
> IMHO, it should be possible to create a single package with gendoc<BR>
> that has _zero_ bad links. This currently is pretty hard :-)<BR>
<BR></DT>
<DT>Hmm, true. I insert all kinds of links, such as when you import modules,
inherit from classes, etc. Maybe add YAO (yet another option) to avoid
generating</DT>
<DT>links to things we're not sure are there (or perhaps the other way
around, an option to generate links regardless if they are seen during
this collect).</DT>
<DT><BR>
> > While on the gendoc thread: I usually run gendoc on everything
in the<BR>
> > standard distribution to put up docs for people in my department.
I<BR>
> > thought of adding<BR>
> > an option to "collect" every module (and package) along
the sys.path.<BR>
> > Comments?<BR>
> <BR>
> Makes sense to me. This is what I do for ni(), so I suppose
it is<BR>
> pretty similar.<BR>
> <BR>
> I also added a "-s" option to gendoc, so the skiplist can
be added<BR>
> to.<BR>
> <BR>
<BR>
-- <BR>
Daniel Larsson, ABB Industrial Systems AB<BR>
</DT>
</BODY>
</HTML>
------------2B107203164210--
_______________
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
_______________