Golden Sphinx

Build and serve Sphinx docs.

Example usage:

$ goldensphinx build serve

You can also just build:

$ goldensphinx build

or just serve:

$ goldensphinx serve

To 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_dir and static_dir by STATIC_DIR
• dest_dir by DOCS_DIR
• port by PORT
• host by HOST
• threads by NUM_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 goldensphinx

Latest:

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

Authors

• Yoav Ram (@yoavram)

Acknowledgements

• The project is inspired by, and the serve command is modified from kennethreitz/goldenarch.
• Many thanks to the authors of Python, Gunicorn, Sphinx, Click, Static and everything else we build our apps with.