zapier/sphinx repository overview

⁠Docker: Sphinx

⁠Setup

This image assumes the following exist in your project:

• ./docs/conf.py - configuration file for Sphinx⁠
• ./docs/index.rst - root reStructuredText file

Alternatively, you could ln -s README.md docs/index.md and add the following to docs/conf.py for Markdown support:

extensions = ['recommonmark', 'sphinx_markdown_tables']

⁠Usage

Run the local development server:

docker run -itv $(PWD):/host -p 8000:8000 zapier/sphinx

Build HTML for upload to S3:

docker run -itv $(PWD):/host zapier/sphinx sphinx-build docs docs/_build/html

⁠Contributing

To test locally:

make build
make test
make run

Pushed changes are automatically built on Docker Hub⁠.

Images are automatically tagged from GitHub Releases⁠.