跳转到主要内容

使编写您的Sphinx文档变得更简单。

项目描述

作者:Kit La Touche

概述

使编写您的Sphinx文档变得更简单。

这是一个用于构建和提供您Sphinx文档的命令行工具。在您的Sphinx Makefile所在的目录中运行此命令,它将在任何 *.rst 改变时构建您的文档,并在 http://localhost:8000 上提供它们。

选项

  • -t, --type: 要运行的make子命令和提供服务的 _build 子目录。默认为 dirhtml

  • -p, --port: 提供文档的端口号。默认为 8000

  • -r, --root: 要构建和提供的Sphinx项目的根目录。默认为 .

  • --help: 显示帮助。

  • --version: 显示版本。

安装/使用

要安装,请使用pip

$ pip install phix

或克隆仓库

$ git clone https://github.com/wlonk/phix.git
$ python setup.py install

然后运行它

$ phix

贡献

将其分叉,创建一个PR,我会查看的!

项目详情


下载文件

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

源代码分发

phix-0.6.1.tar.gz (4.1 kB 查看哈希值)

上传时间 源代码

构建分发

phix-0.6.1-py2.py3-none-any.whl (5.0 kB 查看哈希值)

上传时间 Python 2 Python 3

由...