包括带有nbsphinx的笔记本失败

Question

我是狮身人面像的新手，我想写一个python软件包的文档。当我要包含演示文件时出现问题。我想使用扩展名nbsphinx包含文件demo.ipynb。它已成功安装在我的计算机上。我的conf.py文件中的sphinx扩展名变量包含以下几行：

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

和我的index.rst中的toctree是以下内容：

.. 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中。我没有找到与此问题有关的任何信息。

Answer 1

每个笔记本都需要一个标题。

只需在笔记本中创建一个Markdown单元格，其中包含以下内容：

# My Title

另请参见https://github.com/spatialaudio/nbsphinx/issues/310和https://github.com/spatialaudio/nbsphinx/pull/401。

现在有一个更好的警告，请参阅https://github.com/spatialaudio/nbsphinx/pull/402。