首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Sphinx,如何镜像README.rst和index.rst

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

Stack Overflow用户
提问于 2015-01-28 02:01:30
回答 1查看 332关注 0票数 2

使用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

EN

回答 1

Stack Overflow用户

发布于 2015-03-13 11:12:09

为此,我将文档的源目录设置为项目的根目录。然后,doc/index.rst可以通过包含README.rst或将其放入toctree来将其引用为/README。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/28177015

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档