使用sphinx/github/distribute的自动化文档生成器
Okydok的Python项目详细描述
工作原理
它按以下说明工作:
- 当推送新提交时,github触发okydoky post-receive-hook
- okydoky从github下载推送提交的tarball归档文件
- tarball存档文件被提取到一个临时目录中。
- 斯芬克斯建立文档。
- 当用户使用浏览器请求文档时, okydoky要求用户使用github oauth进行身份验证。
- 如果他们有授权,OkyDoky将提供一个构建文档。