The numpydoc extension converts what I had above to .. seealso::, so that way it looks nice both in Sphinx and in raw source.
For an example of what it does, see the very bottom of http://docs.sympy.org/0.7.1/modules/galgebra/GA/GAsympy.html. Aaron Meurer On Tue, Oct 25, 2011 at 4:41 PM, Vladimir Perić <vlada.pe...@gmail.com> wrote: > There's also a ".. seealso::" directive, but I'm not exactly sure what > it does. It came up when I updated the sphinx-errors branch (pull > request 672). > > On Tue, Oct 25, 2011 at 6:33 PM, Aaron Meurer <asmeu...@gmail.com> wrote: >> A note about "See also" that should maybe be added to the issues (I'll add >> it as a bulk comment when I get internet access): if you format it as >> See Also >> ======== >> :class:`someclass`, :function:`somefunction` >> Then Sphinx (along with the numpydoc extension) will render this nicely. >> Aaron Meurer >> (p.s., the above doesn't actually link to the other functions. Does someone >> know how to do that?) >> >> >> On Monday, October 24, 2011, Hector wrote: >>> >>> >>> On Mon, Oct 24, 2011 at 1:05 PM, Chris Smith <smi...@gmail.com> wrote: >>>> >>>> In this situaion I do: >>>> >>>> >>> [w for w in dir() if 'prime' in w] >>>> ['isprime', 'nextprime', 'prevprime', 'prime', 'primefactors', >>>> 'primelt', 'primepi', 'primerange', 'primetest', 'randprime'] >>>> >>> >>> That is to search functions which contains a word 'prime' and not the >>> function related to `prime`. >>> To illustrate, doc-string of ``factorint`` would cantains ``See also : >>> divisors``. >>> >>>> >>>> -- >>>> You received this message because you are subscribed to the Google Groups >>>> "sympy" group. >>>> To post to this group, send email to sympy@googlegroups.com. >>>> To unsubscribe from this group, send email to >>>> sympy+unsubscr...@googlegroups.com. >>>> For more options, visit this group at >>>> http://groups.google.com/group/sympy?hl=en. >>>> >>> >>> >>> >>> -- >>> -Regards >>> Hector >>> Whenever you think you can or you can't, in either way you are right. >>> >>> -- >>> You received this message because you are subscribed to the Google Groups >>> "sympy" group. >>> To post to this group, send email to sympy@googlegroups.com. >>> To unsubscribe from this group, send email to >>> sympy+unsubscr...@googlegroups.com. >>> For more options, visit this group at >>> http://groups.google.com/group/sympy?hl=en. >> >> -- >> You received this message because you are subscribed to the Google Groups >> "sympy" group. >> To post to this group, send email to sympy@googlegroups.com. >> To unsubscribe from this group, send email to >> sympy+unsubscr...@googlegroups.com. >> For more options, visit this group at >> http://groups.google.com/group/sympy?hl=en. >> > > > > -- > Vladimir Perić > > -- > You received this message because you are subscribed to the Google Groups > "sympy" group. > To post to this group, send email to sympy@googlegroups.com. > To unsubscribe from this group, send email to > sympy+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/sympy?hl=en. > > -- You received this message because you are subscribed to the Google Groups "sympy" group. To post to this group, send email to sympy@googlegroups.com. To unsubscribe from this group, send email to sympy+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sympy?hl=en.
