Golden Sphinx
Build and serve Sphinx docs.
Example usage:
$ goldensphinx build serveYou can also just build:
$ goldensphinx buildor just serve:
$ goldensphinx serveTo see the options you can control, run a command with --help:
$ goldensphinx build --help
Usage: goldensphinx build [OPTIONS]
Options:
--source_dir PATH Directory containing documentation source
--dest_dir PATH Directory to build documentation to
--help Show this message and exit.
$ goldensphinx serve --help
Usage: goldensphinx serve [OPTIONS]
Options:
--static_dir PATH Static directory to serve
--host TEXT Hostname to serve on
--port INTEGER Port to serve on
--threads INTEGER Number of threads
--help Show this message and exit.All options can be also be set using environment variables:
-
source_dirandstatic_dirbySTATIC_DIR -
dest_dirbyDOCS_DIR -
portbyPORT -
hostbyHOST -
threadsbyNUM_SERVER_THREADS
For example:
$ 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)You can also set the environment variable GOLDENSPHINX to false if you want to prevent goldensphinx from running.
Install
Stable:
pip install goldensphinxLatest:
pip install git+https://github.com/yoavram/goldensphinx.gitAuthors
- Yoav Ram (@yoavram)
Acknowledgements
- The project is inspired by, and the
servecommand is modified from kennethreitz/goldenarch. - Many thanks to the authors of Python, Gunicorn, Sphinx, Click, Static and everything else we build our apps with.
