heroku-sphinxbuild-template

by shimizukawa

GitHub Readme.md

Building and Hosting sphinx document on Heroku

This is a heroku template and buildpack for building/hosting sphinx document.

Deploy it

Deploy

Features

  • Building your sphinx document on git repository some where.
  • Serving HTML files that is generated by sphinx-build.
  • Serving HTML files with BASIC authentication for readers if you want.

Limitations

  • Buliding document at once on Heroku building stage.
  • 3rd-party python packages / sphinx extensions are not supported.

ToDo

  • pull & build document every hour/day
  • pull & build document by WebHook
  • Install 3rd-party python packages / sphinx extensions

How it works

This Heroku template will do:

  1. Create Heroku app instance on your account.
  2. Clone your Sphinx documentation from git URL you specified.
  3. Build Sphinx documentation on Heroku building stage.

Frequently Asked Questions