本项目灵感来源于 Docutils 项目。
- README:项目自述。
- FAQ:常见问题(带答案!)
- RELEASE-NOTES:最近版本中主要变化的摘要。
- HISTORY:详细的更改日志,用于当前和所有以前的项目版本。
- BUGS:已知的错误,以及如何报告错误。
- THANKS:贡献者名单。
source/:项目源目录,作为 Python 包安装。docs/:项目文档目录。docs/user/:项目用户文档目录。docs/ref/:项目参考目录。- {file}
LICENSE:项目许可证。 tests/:单元测试。
- 角色 {rst:role}
:daobook:和 {rst:role}:daobook:分别是 {daobook}/和 {daobook}/网址的缩写。 - 网站主题借鉴 sphinx-doc