-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Are you sure the function is correctly documented? If it is, :func:`.funcname` should definitely work (at least with Sphinx 1.0 and higher).
Georg Am 08.01.2011 08:37, schrieb D. M. Monarres: > Thank you for the help. It is still not picking it up unless I write out the > entire function's name. I was just figuring that it was something easy that I > missed. Sphinx is still great though, thanks for all of the hard work. > -- > D. M. Monarres > <dmmonar...@gmail.com <mailto:dmmonar...@gmail.com>> > > > On Fri, Jan 7, 2011 at 2:27 AM, Georg Brandl <ge...@python.org > <mailto:ge...@python.org>> wrote: > > Am 07.01.2011 07:39, schrieb D. Monarres: >> Hello all, > >> Right now I am trying to write a tutorial for the Sage computer >> algebra system that heavily cross-references with the standard >> documentation. Sage loads almost all functions/classes into the >> default namespace so most users know nothing of the module structure >> of program. I was wondering if there would be anyway to strip the >> module info from the :py:*:` ` directive. For example, the user only >> knows about a function named var(), but the real name of this function >> in sage is sage.symbolic.ring.var(). Is there anyway I can link to the >> right place without having the user see the "sage.symbolic.ring" >> portion? The target audience knows very little about python but I >> would like to be able to point to the additional examples in the >> standard reference. > > If there is no ambiguity, you can reference the function as > > :func:`.var` > > It will display as "var" and link to the "sage.symbolic.ring.var" target. > If there is an ambiguity, you will get a warning stating that fact. > >> ps. is there also a way I can have the external crossrefs open in a >> new window? > > Not by default, no -- mandating the opening of links in a new windows > is usually frowned upon nowadays. > > Georg - -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@googlegroups.com <mailto:sphinx-dev@googlegroups.com>. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com <mailto:sphinx-dev%2bunsubscr...@googlegroups.com>. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. > -- > You received this message because you are subscribed to the Google Groups > "sphinx-dev" group. > To post to this group, send email to sphinx-...@googlegroups.com. > To unsubscribe from this group, send email to > sphinx-dev+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/sphinx-dev?hl=en. -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0opbsACgkQN9GcIYhpnLDlBACgoHY1vBOUFSR8J4cxT0Tlavh9 iXEAoIiWJfmq9VQT2df3sXYjeY3S/oSb =osVO -----END PGP SIGNATURE----- -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
