Question

我被蟒蛇sphinx困住了。我的目录树如下所示：

| - project_root
|    | - importable_project
|    |    | - importable_module.py
|    |    | - another_importable_module.py
|    |    | - Tutorials
|    |    |    | - tutorial1.ipynb
|    | - docs
|    |    | - build
|    |    |    | - sphinx_build_files_and_folders
|    |    | - source
|    |    |    | - _static
|    |    |    | - _templates
|    |    |    | - conf.py
|    |    |    | - index.rst
|    |    |    | - modules.rst

我按照说明启用了nbsphinx extention，并且我修改了源文件夹中的index.rst文件。

以下是index.rst目前的文件：

.. Pycotools documentation master file, created by
   sphinx-quickstart on Wed Oct 11 11:46:06 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Pycotools's documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   /modules
   ../../importable_project/Tutorials/tutorial1


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

大部分内容由sphinx-quickstart自动生成。我知道这里指定的文件路径是相对于index.rst文件的位置。因此，在这种情况下，project_root/docs/source和sphinx可以使用上面的moudles.rst文件生成index.rst的html。

问题在于我希望在文档中包含我的教程，但行../../importable_project/Tutorials/tutorial1无法找到tutorial1.ipynb。

有人可以提出我做错的事吗？

Answer 1

教程是文档，应该移到docs/source目录中。除了通过autodoc的软件包外，Sphinx无法在其源目录之外找到文件。移动.ipynb文件后，您需要相应地调整路径。

当sphinx index.rst位于子目录中时，包括ipynb文件

1 个答案: