Phink为Sphinx提供了一个方便的包装器,使项目文档变得轻而易举。
phink的Python项目详细描述
芬克
Phink为Sphinx提供了一个方便的包装器,使项目文档变得轻而易举。在
- 超级容易设置和建立
- 在Markdown中编写文档
- 在开发过程中自动rebuild and reload
- 为API documentation提取docstrings
阅读完整的Phink documentation了解更多信息。在
安装
pip install phink
入门
Create一组示例文档文件:
^{pr2}$Build并提供HTML输出:
phink serve
Edit根据您的喜好,doc/
目录中的文件。
文档将在浏览器中自动重建和重新加载。在
Commit并将其推送到Git存储库。
请确保不要提交doc/_build
目录。在
{{/str}通过^/str}发布^/str}。在
- 项目
标签: