1. Documentation Variations

This documentation is hosted using different branches/ versions, and to different extents depending on the provider, to ensure maximum availability, and specificity so you are never left without documentation.

Note

We use sphinx autodoc to document our API, however because some base libraries are still new and are only really available in dockerland this auto-documentation is not easily implementable on all providers. If you would like to have this auto-documentation please choose a version of the docs with autodoc.

The current variations of the documentation are as follows:

Version

Provider

Link to Documentation

Master

RTD

RTD Documentation Status (Latest/Master)

Stable

RTD

RTD Documentation Status (Latest Stable Release)

Staging

RTD

RTD Documentation Status (Staging)

Dev

RTD

RTD Documentation Status (Staging)

Staging (Autodoc)

GitLab Pages

GitLab Pages Documentation Status (Latest/Master)