如何自定義Sphinx文檔Makefile？

Question

我想知道是否仍然可以自定義sphinx文檔的makefile？

我想要實現的是，每次我make html ，sphinx都會轉到特定目錄，並將特定文件復制到我的source目錄。

---

例如：

假設我在~/bar目錄下有一個名為name foo.py的腳本。 我希望將foo.py復制到~/docs/source/目錄，這將由我的project.rst引用。

---

我要這樣做的原因是，我想將文檔中引用的腳本保持為最新版本，並且每次執行make html時都不想復制粘貼。

我知道我可以通過一個簡單的shell腳本來實現此目的。 但是，我想知道是否可以直接通過sphinx make文件來執行此操作嗎？

非常感謝！

Answer 1

一個簡單的解決方案是創建一個符號/硬鏈接（ ln -s path/to/destination path/to/link ，刪除-s表示硬鏈接）。

在您的情況下， ln -s ~/bar/foo.py ~/docs/source/foo.py將在~/docs/source/目錄中創建一個鏈接（始終是最新的，因為它只是指向您的原始文件）。

對於更高級或更完整的Makefile規則，請查看此自定義的sphinx Makefile 。 有很多規則可以將文件通過Web或從一個目錄發送到另一個目錄（在我的情況下，是~/web-sphinx/.build/html/*到~/Public/ ）。