Divio Documentation

The official documentation for Divio and its products.

Build the documentation locally

You'll need the enchant library, used by pyenchant for spelling.

Install with brew install enchant (macOS) or the appropriate command for your system.

Then:

git clone git@github.com:divio/divio-cloud-docs.git
cd divio-cloud-docs
make install
make run
open http://localhost:9001

Notable techniques used in this documentation

• We serve our documentation via Read the Docs.
• The documentation is written in ReStructed Text (RST) and built using Sphinx.
• Intersphinx to reference to other documentation.

Documentation structure and standards

Our documentation structure is key to its usability. See our What nobody tells you about documentation system for an explanation of why it's important and how it works.

See also our additional documentation standards.