Skip to content

Add infrastructure to build Sphinx API documentation

Darryl Green requested to merge github/fork/bjackman/sphinx-docs into master

Created by: bjackman

This is still slightly rough; the structure of the documentation can probably be improved and I haven't reviewed the entire HTML output. However this should be a proof of concept and provide a base for more complete documentation and automated hosting.

Included:

  • All the boring configuration for sphinx, generated by sphinx-quickstart and sphinx-apidoc. Unfortunately I didn't record the details of the process I used and it was quite a while ago. If we need that info I will just do it again. No need to really review this, just skim the files and see what got added and where.
  • Some miscellaneous bits, as separate commits
  • Mods to the Travis conf so we get notifications if PRs break the doc build.

Merge request reports