Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Python sphinx autosummary error

I have a sphinx document and when I include the following lines:

.. currentmodule:: myMod

.. autosummary::

  MyClass

I get the following error

ERROR: Unknown directive type "autosummary".

Yet, autosummary is available since version 0.6, and I use Sphinx 1.1.3.

What could potentially cause the problem? Thanks!

EDIT: To make it a bit more clear I am talking about python-sphinx, the documentation tool.

like image 580
SmCaterpillar Avatar asked Dec 04 '13 17:12

SmCaterpillar


1 Answers

sphinx.ext.autosummary is a Sphinx extension. In order to use the extension, you must add its name to the extensions configuration variable in conf.py:

extensions = ['sphinx.ext.autosummary', ...]
like image 122
mzjn Avatar answered Nov 15 '22 20:11

mzjn