Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sphinx Autodoc Content: A wiki page with a step-by-step description of the former way of documenting APIs.

edX REST API Conventions: A wiki page in the Architecture space that outlines the conventions to be used for all edX REST APIs.

...

API documentation tools have historically used .rst files, Python docstrings together with the Sphinx autodoc extension, GitHub, and ReadTheDocs. For more information, see Documenting APIs and Sphinx Autodoc Content.