While writing documentation using Sphinx, I know that I can link to a class by using Intersphinx: <pre class="prettyprint"><code>:py:class:`logging.Logger` </code></pre> But how do I link directly to a specific method, like <code>logging.Logger.warning()</code>?

Just use <pre class="prettyprint"><code>:py:meth:`module.class.mymethodname` </code></pre>

How can I hyperlink a method from a Python module in Sphinx?

While writing documentation using Sphinx, I know that I can link to a class by using Intersphinx:

:py:class:`logging.Logger`

But how do I link directly to a specific method, like logging.Logger.warning()?

988

asked Aug 05 '11 13:08

Just use

:py:meth:`module.class.mymethodname`

164

answered Nov 09 '22 17:11

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!