[Numpy-discussion] Documentation

[Charles R Harris]

On 5/15/07, Alan G Isaac <aisaac at american.edu> wrote:
>
> On Tue, 15 May 2007, Charles R Harris apparently wrote:
> > If a CSS can set all the font styles, item spacing, and
> > treatment of explanatory text, that would be the more
> > flexible route.
>
> I'm not sure what "treatment" meams here,
> but if it is a matter of font decisions or spacing,
> the answer should be yes.


The item in a consolidated list is divided into three parts: name, type,
explanation. I see no way in the CSS to control the display of those parts,
although it might be an undocumented feature. I basically want it to look
like a definition list with maybe the current default for type, which puts
it in parenthesis.

> If we can also make SeeAlso generate links to the
> > referenced  routines I will be very satisfied.
>
> epydoc supports documentation cross-reference links.
> I think you get what you want (if I understand) just
> but putting the name in back ticks, `like_this`.
> That will give me a link to the like_this function
> in the same module (and maybe anywhere in the package,
> but I'm not sure).


Yes, I just noticed that. One less thing to worry about.

Chuck
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20070515/91c13310/attachment.html>