2016-02-12 2 views
1

Я не могу корректно работать с Sphinx в формате numpy. Я тестирую с этим example, выполняя «сделать HTML», но я получаю несколько предупреждений распознавать параметры, примечания, возврат и т.д. Например:Sphinx Неожиданный заголовок раздела - numpydoc

SEVERE: Unexpected section title. 
ERROR: Unexpected indentation. 
also 
WARNING: Inline emphasis start-string without end-string. 
WARNING: Literal block expected; none found 

Этот вопрос не был уже задавала, но у меня нет успех после поиска и попыток в течение нескольких часов.

То, что я не сделал до сих пор:

  • установлен Sphinx v1.3.5
  • обновленный numpydoc до версии 0,5
  • добавлены какие расширения numpydoc, sphinxcontrib.napoleon и sphinx.ext.napoleon в файл conf.py.
  • пытался rst2html docum.txt docum.html
  • Как я пришла в голову мысль, что он не использовал numydoc, я написал неверное имя, расширение и это дало ошибку (как это должно быть, так что я думаю, что это identifing numpydoc).
  • добавил numpydoc_show_class_members = False к conf.py
  • удаления Весь предыдущий результат HTML

Любое предложение или намек на то, что это не так? Что я могу попробовать?

Благодаря

+1

Добро пожаловать в stackoverflow. Расскажите нам больше о том, что вы пробовали в противном случае, вы получите те же предложения, которые вы прочитали. – bibi

+0

Спасибо, я уже это сделал. –

+0

Всякий раз, когда у меня были такие проблемы, что-то было отступом на два или два места, в которых я не видел. Или, я забыл несколько новых строк. Есть ли номера строк? Другая мысль: использовать бинарный поиск. Комментировать вне HALF документ и увидеть проблему все еще происходит. Выясните, в какой половине проблемы, и продолжайте пытаться, пока вы не выделите проблему на несколько строк. – rts1

ответ

1

Проблема заключалась в том, что я использовал numpydoc документировать модуль непосредственно с .. toctree:: filename, но он должен быть использован с .. automodule:: filename. Существует более подробная информация о том, как его использовать здесь: http://www.sphinx-doc.org/en/stable/tutorial.html#setting-up-the-documentation-sources. Спасибо за вашу помощь.

Смежные вопросы