Sphinx,如何镜像README.rst和index.rst

时间:2015-01-27 18:01:30

标签: python python-sphinx

使用sphinx,如何将我的git存储库根目录中的README.rst包含在我的sphinx文档中的index.rst中?我正在使用apidoc和autodoc。一个很好的例子是APScheduler,如果你看起来你会注意到他们的docs / index.rst几乎与他们的README.rst相同

https://bitbucket.org/agronholm/apscheduler/src/11c5c1e7b8c3?at=2.1

1 个答案:

答案 0 :(得分:0)

我这样做是为了让文档的源目录成为项目的根目录。然后doc / index.rst可以通过包含或将它放入toctree来将README.rst称为/ README。