Welcome to sphinx-github-githook’s documentation!

Contents:

Indices and tables

My goal was originally to make a githook that will generate sphinx docs and push them to a gh-pages branch pre-push. AWESOME

However, you SHOULD know that it’s currently QUITE TEMPERMENTAL. Bummer! Also, undoxxed so far, but it will be doxxed, since the docs will also serve as a test for this kinda thing.

Also: My goal now is not to make a single githook that does everything, but a series of little scripts that make it easy-ish to shove compiled html docs to gh-pages (probably combined with the standard sphinx Makefile), perhaps coupled with a githook or two. Once I decide, I’ll make sure this project’s name reflects its true nature! I’m on a horse.

Table Of Contents

This Page