title: How to document Python function parameters with sphinx-apidoc?
body: <p>I'm trying to clean up my python code documentation, and decided to use <a href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html" rel="noreferrer">sphinx-doc</a> because it looks good.  I like how I can reference other classes and methods with tags like:</p>
  
  <pre><code>:class:`mymodule.MyClass` About my class.
  :meth:`mymodule.MyClass.myfunction` And my cool function
  </code></pre>
  
  <p>I'm trying to figure out though how to document parameter names in a function, so that if I have a function like:</p>
  
  <pre><code>def do_this(parameter1, parameter2):
     """
     I can describe do_this.
  
     :something?:`parameter1` And then describe the parameter.
  
     """
  </code></pre>
  
  <p>What's the best practice for this?</p>
  
  <p><strong>Update:</strong></p>
  
  <p>The correct syntax is:</p>
  
  <pre><code>def do_this(parameter1, parameter2):
     """
     I can describe do_this.
  
     :something parameter1: And then describe the variable
     """
  </code></pre>