It appears that this form does what I need (cross-reference):
.. py:method:: make_a_foo() -> a foo thing
:rtype: :py:class:`foo`
.. py:class: foo()
But I was hoping for something a bit more compact and elegant... but it
appears that the stuff following the -> can't really have much in the way
of in-line syntax...
--
Viktor
On Tuesday, 5 June 2012 15:34:55 UTC-4, Viktor Haag wrote:
>
> I have these docs:
>
> .. py:method:: make_a_foo() -> :py:class:`foo` instance
>
> .. py:class:: foo()
>
> Unfortunately, this doesn't do what I'd hoped. I'd /like/ the reference to
> a 'foo' in the method definition would produce a cross-reference to the
> 'foo' class definition in the docs, but it doesn't seem to...
>
> Is there a way that I can write the factory method's docs to include a
> cross-reference?
>
> Thanks!
>
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To view this discussion on the web visit
https://groups.google.com/d/msg/sphinx-dev/-/UZi2Q1hkFjMJ.
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/sphinx-dev?hl=en.
