文件名称:Continuous-docs:用于在Python中连续生成文档的教程和示例包
文件大小:10KB
文件格式:ZIP
更新时间:2024-03-11 20:49:26
Python
Python连续文档 介绍 如果您拥有使用文档字符串的Python库,那么很容易开始将这些文档字符串转换为漂亮HTML,托管在,并在每次推送到GitHub时更新。 该存储库旨在作为该方法的工作示例,请查阅 。 本教程使用 ,但是有一个的旧版本。 为什么不使用 ? 请做! 本教程只是提供了一种替代方法。 设置项目 安装 与往常一样,我建议使用进行本地Python开发。 在您的virtualenv内部,运行: pip install sphinx 设置 在您的项目中创建一个doc目录,稍后我们将其添加到git中: mkdir -p doc cd doc 创建基本配置和文件结构: sphinx-quickstart 您需要为非默认答案提供以下几个问题: > Separate source and build directories (y/N) [n]: y > Project n
【文件预览】:
continuous-docs-main
----docpkg()
--------config.py(631B)
--------main.py(160B)
--------__init__.py(204B)
----doc()
--------source()
--------requirements.txt(46B)
--------Makefile(638B)
----.travis.yml(477B)
----LICENSE(1KB)
----setup.py(187B)
----README.md(7KB)
----.gitignore(2KB)