On Mon, May 18, 2009 at 12:03 AM, David Roe <[email protected]> wrote:
> I think that adding a section to
> http://www.sagenb.org/doc/live/developer/conventions.html#documentation-strings
> 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 [email protected]
To unsubscribe from this group, send email to 
[email protected]
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---

Reply via email to