не удается включить ноутбук с nbsphinx - PullRequest
Новая
       20

не удается включить ноутбук с nbsphinx

0 голосов
/ 22 марта 2019

Я новичок в sphinx и хочу написать документацию по пакету python.У меня проблема, когда я хочу включить демонстрационный файл.Я хочу включить файл demo.ipynb, используя расширение nbsphinx.Он успешно установлен на моем компьютере.Переменная extensions в моем файле conf.py для sphinx содержит следующие строки: 

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.coverage',
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages',
    'sphinx.ext.napoleon',
    'nbsphinx',
]

, а toctree в моем index.rst следующий: 

.. toctree::
   :maxdepth: 3
   :glob:

   demo

, когда я компилируюдокументация Я всегда получаю следующее предупреждение: 

PATHTOPACKAGE/docs/source/index.rst:19: WARNING: toctree contains reference to document 'demo' that doesn't have a title: no link will be generated

Может ли sphinx попытаться включить файл в качестве первого файла?В документации nbsphinx просто сказано, что мне нужно установить пакет, добавить nbsphinx к расширениям, и тогда я смогу добавить свои документы в toctree.Я не нашел никакой информации, связанной с этой проблемой.

...