Skip to main content

Phink 为 Sphinx 提供了一个方便的包装器,使项目文档变得轻而易举。

项目描述

芬克

派皮 构建状态 文件状态

Phink为Sphinx提供了一个方便的包装器,使项目文档变得轻而易举。

阅读完整的Phink 文档以了解更多信息。

安装

    pip install phink

入门

创建一组示例文档文件:

    cd your_project_directory
    phink init

构建并提供 HTML 输出:

    phink serve

doc/根据自己的喜好编辑目录中的文件。文档将在您的浏览器中自动重建和重新加载。

提交并推送到您的 Git 存储库。确保您没有提交该doc/_build目录。

按照RTD 导入文档发布到 ReadTheDocs 。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

phink-0.2.0.tar.gz (17.6 kB 查看哈希

已上传 source

内置分布

phink-0.2.0-py3-none-any.whl (20.9 kB 查看哈希

已上传 py3