For some reason the documentation in the reference manual
seems to be different from the documentation in the docstrings.

I think if the docstrings were sufficiently expanded then it should
be possible to extract the reference manual directly from the
docstrings.

Regards,
Michel



On May 18, 9:09 am, Mike Hansen <mhan...@gmail.com> wrote:
> On Mon, May 18, 2009 at 12:03 AM, David Roe <r...@math.harvard.edu> wrote:
> > I think that adding a section to
> >http://www.sagenb.org/doc/live/developer/conventions.html#documentati...
> > for TEST and SEE ALSO would be good.  Encouraging people to reference other
> > functions that they user might be looking for, and providing an example of
> > how to hyperlink between docstrings, would be very nice.
> > David
>
> There is also the ".. seealso::" directive in Sphinx.  For things
> hyperlinks, you use the roles like :obj:, :func:, :mod:, :meth:.
> These can be found in the Sphinx documentation.
>
> --Mike
--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to sage-devel@googlegroups.com
To unsubscribe from this group, send email to 
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---

Reply via email to