Add reference instructions into object description units doc

[shimizukawa]

It will help a lot if unit descriptions contain information how to reference them. For example, function definition at http://sphinx.pocoo.org/markup/desc.html#dir-function could include a reference to http://sphinx.pocoo.org/markup/inline.html#role-func.

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/338
• Originally reported by: anatoly techtonik
• Originally created at: 2010-02-23T19:03:57.313

[shimizukawa]

From Georg Brandl on 2010-02-27 22:00:13+00:00

That's a very good point. I'll have to restructure that documentation anyway in the domains branch, so it will be fine in 1.0.

[shimizukawa]

From Georg Brandl on 2010-05-30 09:57:56+00:00

Should be much better now in tip, see http://sphinx.pocoo.org/latest/domains.html.

[shimizukawa]

From Georg Brandl on 2011-09-22 10:14:40+00:00

Removing milestone: 1.0 (automated comment)

[shimizukawa]

From Georg Brandl on 2013-03-31 13:57:20+00:00

Removing version: 0.6.4 (automated comment)

[skidzo]

http://sphinx.pocoo.org/markup/desc.html
this link is broken, it is totally unclear what i should use to document the returned value, rtype, returns, or return???

[tk0miya]

This is closed 4 years ago. This is issue tracker. Please post your questions to sphinx-users forum.

BTW, both return and returns are same meaning. so either is okay. But rtype is used to indicate type of return value. so it is not better to use for description.

[skidzo]

Thanks :-)