包含带有nbsphinx的笔记本失败

2024-04-29 12:53:05 发布

您现在位置:Python中文网/ 问答频道 /正文

我是sphinx新手,我想写一个python包的文档。我有一个问题,当我想包括一个示范文件。 我想把文件包括进去演示.ipynb使用扩展名nbsphinx。它已成功安装在我的计算机上。我的扩展变量配置文件sphinx的文件包含以下行:

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

还有我的索引.rst如下所示:

^{pr2}$

当我编译我的文档时,我总是得到以下警告:

^{3}$

斯芬克斯是否会尝试将该文件作为rst文件包含?nbsphinx文档只是说我必须安装包,将nbsphinx添加到扩展中,然后我就可以将我的文档添加到目录树中。我没有找到任何与这个问题有关的信息。在


Tags: 文件文档配置文件计算机sphinxcoverageextensionsrst