Ambition Docs Guide Documentation

This guide is meant for developers new to reStructuredText and Sphinx to quickly pick up key points for adding documentation to python code and projects.

Overview

Sphinx is a tool that generates documentation from reStructuredText. Output formats include HTML, pdf, epub, manpage, and many others.

reStructuredText is a markup language primarily for python documentation.

Getting Started

In all current Ambition app templates, there is now a docs folder in the root of the project, this is the source for Sphinx documentation.

Common reStructuredText and Sphinx commands will be documented here:

• Python Docstrings
• Using Sphinx Autodoc
• Sphinx reStructuredText primer