markstory / sphinxcontrib-phpdomain

A PHP domain for sphinx. Allows you to annotate PHP objects in your sphinx docs.
Other
19 stars 15 forks source link

Link body of return type to the xref for the type #29

Closed ramsey closed 4 years ago

ramsey commented 4 years ago

This change sets bodyrolename='obj' on the returntype field, so that it automatically adds an xref, if it resolves the type to a name in the domain (see attached screenshot).

Related feature for the future: Figure out a way to split the pipe in union types and link each individual target in the type definition. I started trying this, but it turned out to be more difficult than I thought.

Screen Shot 2020-03-03 at 15 21 42
markstory commented 4 years ago

Thank you 👍