如何将子目录及其内容包含在Sphinx输出/构建目录中？

Question

我的Sphinx项目有以下目录结构。

• 根
  • 构建
  • 源
    • index.md
    • 片段

我想按原样将root/source/snippets复制到build/html/snippets;此目录包含代码段文件。

我认为.. include::，:download:和html_extra_path不是我需要的。有没有办法使用构建配置执行此操作？或者是修改make构建脚本的唯一方法。

我正在使用Python v2.7.13和Sphinx v1.5.1。

Answer 1

修改makefile很简单。我拿了我的，只添加了两行，它对我有用。

html:
    mkdir -p $(BUILDDIR)/html $(BUILDDIR)/doctrees
    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
    mkdir -p $(BUILDDIR)/html/snippets
    cp snippets/* $(BUILDDIR)/html/snippets

否则，我没有尝试过，但也许sphinxcontrib-rawfiles会将文件复制到您想要的目录中。

Answer 2

我刚遇到这个问题，可以用Python 3.8回答Sphinx 3.3。

我要做的就是将html_extra_path = ['extra']放入conf.py中。然后，我做了docs/extra/snippets。现在snippets及其所有内容都被复制到_build/html/snippets中。