«Неожиданный заголовок раздела» со Сфинксом - это проблема? - PullRequest
Новая
       8

«Неожиданный заголовок раздела» со Сфинксом - это проблема?

4 голосов
/ 23 июня 2010

При запуске 

sphinx-build . html/

в моем каталоге doc/ я получаю следующий вывод: 

$ sphinx-build . html/
Running Sphinx v0.6.4
No builder selected, using default: html
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] index                 
reST markup error:
HIDDEN/PATH/matplotlib_visualization.py:docstring of simulator.extensions.matplotlib_visualization.beta:20: (SEVERE/4) Unexpected section title.

Этот файл имеет numpy импорт, и после небольшого исследования,похоже, что разметка RST, которую использует sphinx, имеет проблему с тем, как задокументирована numpy.Когда я беру импорт numpy, HTML-версия работает нормально.

Как лучше всего решить эту проблему?

1 Ответ

3 голосов
/ 30 марта 2011

Тема обсуждается в этой теме: https://groups.google.com/d/msg/sphinx-users/MAFTlX8pAvk/B9hx7MuBVbIJ

Pierre GM говорит: "fredrik, похоже, вы используете стандарт thump для своей документации. Рассмотрите возможность использования расширений numpydoc, которые реализовал Pauli Virtanen: доступно здесь: http://sphinx.googlecode.com/svn/contrib/trunk/ "

Текущая информация о numpydoc: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

Перемещенная информация о NumpyDoc: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard

...