我的笔记的Sphinx来源的位置 - 警告：该文档不包含在任何目录中。

Question

如何修复Sphinx底部的警告？

我试图在Sphinx中使用我的Python笔记，我把我的笔记放在单独的文件中，与Sphinx的目录级别相同。索引.rst.

在构建HTML后，我得到以下警告

警告

/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree

在

建设时的完整信息

sudo sphinx-build -b html ./ _build/html
Running Sphinx v0.6.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 1 added, 2 changed, 0 removed
reading sources... [100%] trig_functions
/home/heo/S_codes/databooklet.rst:1: (WARNING/2) malformed hyperlink target.
/home/heo/S_codes/index.rst:11: (ERROR/3) Error in "toctree" directive:
invalid option block.

.. toctree::
   :numbered:
   :glob:
   *
   databooklet.rst
   trig_functions.rst


/home/heo/S_codes/trig_functions.rst:11: (ERROR/3) Unexpected indentation.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/heo/S_codes/databooklet.rst:: WARNING: document isn't included in any toctree
/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] trig_functions
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 6 warnings.

Answer 1

你知道Sphinx的文档吗？ https:/www.sphinx-doc.org

具体来说，阅读关于 toctree 指令。https:/www.sphinx-doc.orgenmasterusagerestructuredtextdirectives.html#directive-toctree

你可以拥有任何你想要的文件。 通过 toctree 你可以从多个部分创建一个文档。

---

请实际 阅读 这个。http:/sphinx.pocoo.orgconcepts.html#document-name。

由于reST源文件可以有不同的扩展名（有些人喜欢.txt，有些人喜欢.rst--扩展名可以用source_suffix配置），不同的操作系统有不同的路径分隔符，Sphinx对它们进行了抽象：所有的 "文档名 "都是相对于源目录的，扩展名被剥离，路径分隔符被转换为斜线。所有引用 "文档 "的值、参数等都期望有这样的文档名。

文件名的例子有 index, library/zipfile或 reference/datamodel/types. 请注意，没有前导斜线。

由于您用 *你不需要列出你的文件。

如果你想列举你的文件，请真正的 阅读 和 遵循 上述规则。