Documentation Standards#

Standards, templates, and editorial guidelines for API docstrings, doctests, and Sphinx web documentation.


Documentation Sections#

Section

Description

API documentation guidelines

Docstrings format, templates, typing, and executable doctests

Documentation for the web

MyST Markdown, Sphinx cross-linking, references, and web components