How to: Add new annotations and extracted docs#

Example annotations and automated docs#

Annotations are a great way to keep documentation close to the code, but also be able to extract into documentation to be published on Readthedocs.

As an example, we have added feature toggle annotations to the edx-platform codebase. A Readthedocs document with the edx-platform feature toggles has been generated from them.

Add your own annotations and docs#

The following steps need to be performed to document new types of annotations in edx-platform. Adapt the final steps as appropriate for other services.