如何自定义sphinx文档makefile?

时间:2016-01-20 07:13:48

标签: python makefile python-sphinx

我想知道是否有自定义sphinx文档makefile?

我想要实现的是每次执行make html时,sphinx都会转到某个目录并将特定文件复制到我的source目录。

例如:

假设我在foo.py目录下有一个名为~/bar的脚本。我希望将foo.py复制到~/docs/source/目录,我的project.rst会引用该目录。

我想这样做的原因是我希望将我在doc中引用的脚本保留为最新版本,并且我不想每次执行make html时都进行复制粘贴。

我知道我可以使用简单的shell脚本实现此目的。但是,我想知道我是否可以直接通过sphinx make文件来做到这一点?

非常感谢!

1 个答案:

答案 0 :(得分:1)

一个简单的解决方案是创建符号/硬链接(ln -s path/to/destination path/to/link,删除-s以获取硬链接。

在您的情况下,ln -s ~/bar/foo.py ~/docs/source/foo.py将在~/docs/source/目录中创建一个链接(始终是最新的,因为它只是指向原始文件的链接)。

对于更高级或更完整的Makefile规则,请查看this customized sphinx Makefile。有很多规则可以通过网络或从一个目录向另一个目录发送文件(在我的情况下为~/web-sphinx/.build/html/*~/Public/)。