Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>Yes, that should work. From <a href="http://sphinx.pocoo.org/ext/autodoc.html" rel="nofollow">the documentation</a>:</p> <blockquote> <p>In an automodule directive with the members option set, only module members whose <code>__module__</code> attribute is equal to the module name as given to automodule will be documented. This is to prevent documentation of imported classes or functions.</p> </blockquote> <hr> <p>Update:</p> <p>The problem seems to be that the <code>__module__</code> attribute of many <code>pylab</code> members is <code>None</code> (the members defined in the C/Cython module <code>mtrand</code>, as far as I can tell).</p> <p>The <code>mtrand</code> module is part of NumPy. Behind the scenes, <code>pylab.beta</code> (and several other functions) is a method of the class <a href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.random.mtrand.RandomState.html" rel="nofollow"><code>numpy.random.mtrand.RandomState</code></a>. I can reproduce the documentation issue as follows:</p> <p>With this source (pylabtest.py)</p> <pre><code>from pylab import beta def mzjn(x): """mzjn docstring""" return x </code></pre> <p>and this source documentation (pylabtest.rst)</p> <pre><code>Pylab test ========== .. automodule:: pylabtest :members: </code></pre> <p>the Sphinx output in pylabtest.html includes both <code>beta</code> and <code>mzjn</code>. </p> <p>But if </p> <pre><code>beta.__module__ = "pylab" </code></pre> <p>is added to pylabtest.py, only <code>mzjn</code> is documented. </p>
    singulars
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. This table or related slice is empty.
    2. VO
      singulars
      1. This table or related slice is empty.
    3. VO
      singulars
      1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload