I can not make Sphinx work correctly with numpy format. I am testing with this example, executing "make html", but I get several warnings to recognize Parameters, Notes, Returns, etc. For example:
SEVERE: Unexpected section title.
ERROR: Unexpected indentation.
also
WARNING: Inline emphasis start-string without end-string.
WARNING: Literal block expected; none found
This question has been already asked, but I have no success after searching and trying for hours.
What I have done until now:
- installed Sphinx v1.3.5
- updated
numpydoc
to the version 0.5 - added the extensions
numpydoc
,sphinxcontrib.napoleon
, andsphinx.ext.napoleon
to theconf.py
file. - tried rst2html docum.txt docum.html
- As I had the idea that it was not using numydoc, I wrote an incorrect name as extension and it gave an error (as it should be, so I think it is identifing numpydoc).
- added
numpydoc_show_class_members = False
toconf.py
- removing the whole previous html output
Any suggestion or hint of what is wrong? What could I try?
Thanks
The problem was that I was using numpydoc to document a module directly with
.. toctree:: filename
, but it has to be used with.. automodule:: filename
. There is more information on how to use it here: http://www.sphinx-doc.org/en/stable/tutorial.html#setting-up-the-documentation-sources. Thanks for your help.