goldensphinx 0.0.3

# Golden Sphinx

构建和提供Sphinx文档。

示例用法

```sh
$ goldensphinx build serve
```

您也可以仅构建

```sh
$ goldensphinx build
```

或仅提供

```sh
$ goldensphinx serve
```

要查看您可控制的选项，请运行带有`--help`的命令

```sh
$ goldensphinx build --help
用法：goldensphinx build [选项]

选项
--source_dir PATH 包含文档源目录
--dest_dir PATH 构建文档到的目录
--help 显示此信息并退出。

$ goldensphinx serve --help
用法：goldensphinx serve [选项]

选项
--static_dir PATH 提供静态目录
--host TEXT 在上提供的主机名
--port INTEGER 在上提供的端口
--threads INTEGER 线程数
--help 显示此信息并退出。
```

所有选项也可以通过环境变量设置

- `source_dir` 和 `static_dir` 通过 `STATIC_DIR`
- `dest_dir` 通过 `DOCS_DIR`
- `port` 通过 `PORT`
- `host` 通过 `HOST`
- `threads` 通过 `NUM_SERVER_THREADS`

例如

```sh
$ export PORT=8080
$ goldensphinx serve --host 127.0.0.1
[2016-09-06 10:02:14 +0300] [55096] [INFO] Starting gunicorn 19.6.0
[2016-09-06 10:02:14 +0300] [55096] [INFO] Listening at: http://127.0.0.1:8080 (87302)
```

如果您想防止goldensphinx运行，可以将环境变量`GOLDENSPHINX`设置为`false`。

## 安装

稳定版

```sh
pip install goldensphinx
```

最新版

```sh
pip install git+https://github.com/yoavram/goldensphinx.git
```

## 作者

- Yoav Ram (@yoavram)

## 致谢

- 该项目灵感来源于，`serve`命令修改自[kennethreitz/goldenarch](https://github.com/kennethreitz/goldenarch)。
- 感谢Python、Gunicorn、Sphinx、Click、Static等所有我们构建应用程序的作者。