根据the docs:
指令参数是要包含的文件的路径,相对于包含该指令的文档。
我有以下结构:
.
├── ALGORITHM.rst
├── doc
│ └── source
│ ├── index.rst
│ └── conf.py
└── README.rst
在 index.rst 里面,我有:
.. bork a bork documentation master file, created by
sphinx-quickstart on Wed Apr 6 17:02:53 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to bork a bork's documentation!
=======================================
Contents:
.. toctree::
:maxdepth: 2
.. include:: ../../README.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
README.rst
Nothing to see here, move along
.. include:: ALGORITHM.rst
ALGORITHM.rst
Hello! I'm an algorithm!
conf.py
正是sphinx-quickstart提出来的。
现在,鉴于文档,我希望这会起作用,因为README.rst
和ALGORITHM.rst
是并排的。实际上,如果我只是在README上做rst2html.py
它就可以了。
但问题是,当我尝试使用sphinx-build
进行构建时,它会告诉我:
README.rst:3: SEVERE: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'doc/source/ALGORITHM.rst'.
这向我表明,include指令并没有像我想象的那样工作。是否可以以这种方式使用包含,或者我是否必须重新构建我组织文档的方式?