Hi, I've encountered this problem also... :type: knows to automatically produce cross-reference where :type: doesn't produce it automatically unless you explicitly specify it.
:type <param-name>: <class-name> - does produce cross-reference to <class-name> :rtype: <class-name> - does NOT produce cross-reference to <class-name> :rtype: :py:class:`<class-name>` - does produce cross-reference to <class-name> Does anyone knows about intention to enhance sphinx in this area? Who should I contact to push this change in sphinx? Regards, Tomer On Tuesday, June 5, 2012 11:01:11 PM UTC+3, Viktor Haag wrote: > > 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/-/O_4C8WpwvH4J. To post to this group, send email to sphinx-dev@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.
