我已经为我的项目编写了一些文档(在Python文档字符串中),并在我的本地计算机上使用Sphinx测试了一切 - 一切正常,所有导入工作正常等等.所以我成立了阅读文档(自定义的环境Python 3,numpydoc我的库),增加了docs目录(和docs/source子目录),以我的GitHub库,并在阅读文档构建通过,但是,创建无(该View Docs链接只显示一个Nginx 404页面).日志如下:
State: Finished
Outcome: Passed
Version: latest
Type: html
Sphinx Standard Output
html
-----
Making output directory...
Running Sphinx v1.2.2
loading translations [en]... done
building [readthedocs]: targets for 5 source files that are out of date
updating environment: 5 added, 0 changed, 0 removed
reading sources... [ 20%] contents
reading sources... [ 40%] source/contents
reading sources... [ 60%] source/index
reading sources... [ 80%] source/kineticlib
reading …标题说明了一切.我想象的是为我的所有模块,类和函数提供docstrings,并通过github(wiki？)以某种方式很好地导航文档.此外,文档应与最新代码同步,这意味着它应该在推送时更新/重新生成.那可能吗？