Documentation is very important to the project, whether in the form of user documentation or class/function documentation. In recent years, we’ve been making an effort to move to a standard documentation format for our code across all the languages we work with.

Good codebase documentation offers many advantages:

• Well-written docs make it easier for us to understand your code and to give it a proper review.
• New contributors to the project will have an easier time understanding the responsibilities for the code they’re working with, making it harder to break things.
• Third-parties wanting to write code against our public interfaces will have a better idea of how.

You’ll be expected to write codebase docs for any contributions you have. This guide will cover our content requirements, the expected format for Python docs and JavaScript docs, and will cover the standard format we use for writing doc content.

Content Guidelines

Standard Documentation Format

Writing Python Docs

Writing JavaScript Docs

Writing CSS/LessCSS Docs

Writing Go Docs

Tools

• Sphinx — The doc parsing library we use.
• beanbag-docutils — The module we use to parse our doc syntax.