[SciPy-User] [SciPy-user] Using Sphinx with numpy/scipy template

josef.pktd@gmai... josef.pktd@gmai...
Fri Oct 1 08:17:20 CDT 2010


On Fri, Oct 1, 2010 at 9:13 AM,  <josef.pktd@gmail.com> wrote:
> On Wed, Sep 29, 2010 at 7:20 AM, bfrenay <bfrenay@gmail.com> wrote:
>>
>> Hello,
>>
>> I just migrated all my code documentation to the numpy/scipy format.
>> However, I have some problems with sphinx.  I have (i) installed sphinx and
>> numpydoc using easyinstall, (ii) inserted the following line in conf.py
>>
>> extensions= ['sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'numpydoc']
>>
>> and (iii) created a simple, dummy index.rst file reproduced here bellow
>>
>> .. project documentation master file
>>
>> .. automodule:: project.datasets
>>    :members:
>>
>> However, I only get errors (reproduced after the message).  Does anyone have
>> an idea about what is going on, please ?
>>
>> Thank you,
>>
>> Benoît
>>
>> $ make html
>> sphinx-build -b html -d _build/doctrees   . _build/html
>> Running Sphinx v1.0.4
>>
>> Exception occurred:
>>  File
>> "/usr/local/lib/python2.6/dist-packages/numpydoc-0.3.1-py2.6.egg/numpydoc/numpydoc.py",
>> line 136, in get_directive
>>    raise RuntimeError("No directive named '%s' found" % name)
>> RuntimeError: No directive named 'function' found
>> The full traceback has been saved in /tmp/sphinx-err-pCQ8Df.log, if you want
>> to report the issue to the developers.
>> Please also report this if it was a user error, so that a better error
>> message can be provided next time.
>> Either send bugs to the mailing list at
>> <http://groups.google.com/group/sphinx-dev/>,
>> or report them in the tracker at
>> <http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
>> make: *** [html] Erreur 1
>> --
>> View this message in context: http://old.nabble.com/Using-Sphinx-with-numpy-scipy-template-tp29837454p29837454.html
>> Sent from the Scipy-User mailing list archive at Nabble.com.
>
> copied form an earlier thread, It should still work with an older sphinx
>
> ---------
> On Mon, Jul 26, 2010 at 1:56 PM, Gael Varoquaux
> <gael.varoquaux@normalesup.org> wrote:
>> On Mon, Jul 26, 2010 at 01:52:06PM -0700, Matthew Brett wrote:
>>> http://old.nabble.com/numpydoc-broken-by-latest-sphinx-td28896476.html
>>> http://projects.scipy.org/numpy/ticket/1489
> ----
>
> fix was applied in numpy, see ticket; maybe also in numpydoc

looks like numpydoc is here
http://github.com/numpy/numpy/tree/master/doc/sphinxext

Josef

>
> Josef
>>
>> _______________________________________________
>> SciPy-User mailing list
>> SciPy-User@scipy.org
>> http://mail.scipy.org/mailman/listinfo/scipy-user
>>
>


More information about the SciPy-User mailing list