autosummary «toctree содержит ссылку на несуществующий документ» предупреждения

Я столкнулся с той же проблемой, что и в этой ветке. Когда я создаю документацию Sphinx с помощью make html, я получаю много подобных предупреждений.

None:None: WARNING: toctree contains reference to nonexisting document u'cars.Car.time_elapsed'

Я использую html_theme = 'sphinx_rtd_theme'. Если я изменю его на classic, я не получу предупреждений. Если я добавлю numpydoc_show_class_members = False к conf.py, то я их тоже не получу.

НО; Мне очень нравится sphinx_rtd_theme, и когда я использую classic или добавляю numpydoc_show_class_members = False, удаляется "TOC" моих методов Python, которые я предпочитаю оставить (см. красную рамку на изображении).

изображение

Документацию модуля cars составляет

.. automodule:: cars
   :members:

Модуль содержит один класс Car с двумя методами. Строки документации написаны на numpydoc.


person mr.bjerre    schedule 02.09.2016    source источник


Ответы (1)


Мне кажется, что вы сейчас используете расширение numpydoc. Обратите внимание, что строки документации в стиле Numpy и Google теперь поддерживаются встроенным расширением sphinx.ext.napoleon.

Удаление расширения numpydoc и использование sphinx.ext.napoleon, скорее всего, решит вашу проблему.


Источники

person Kurt Bourbaki    schedule 05.04.2017