如何添加位于 sphinx 处理文档的 docs 目录之外的 ipynb 笔记本？

Question

我的项目有以下文件夹结构。

examples

中有 .ipynb 笔记本，我想使用 nbsphinx 扩展名由 sphinx 渲染它们。

当

examples

文件夹位于

doc

内时，我没有遇到任何问题。我重组了文件夹并将

examples

带到了

doc

之外，但我无法进行相对导入。我在 github 和 stackoverflow 上搜索过，但没有找到任何解决方案。

非常感谢任何帮助。

Answer 1

我最近也遇到了同样的问题。

我找到了这个复制品： https://github.com/useblocks/sphinx-collections/tree/master

文档中的示例有一些错误。但这是任何人都无法通过一点尝试来解决的。

结果差不多是这样的：

pip install sphinx-collections

然后将扩展添加到Sphinx项目的

conf.py

文件中：

extensions = [
    "sphinxcontrib.collections",
    # other extensions
]

Sphinx-Collections 在 conf.py 文件中设置： 驱动程序文档

collections = {
    'notebooks': {
        'driver': 'copy_folder',
        'source': '/path/to/notebooks',
        'target': 'notebooks/',
        'ignore': ['*.py', '.sh'],
    }
}

使用

copy_folder

驱动程序，文件将复制到

docs/_collections/<target>

然后只需在第一个文件中引用它

notebooks documentation
=======================

.. toctree::
   _collections/notebooks/ingest
   # more notebooks (fileextension is not needed)