Versions Compared

Key

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

...

API documentation has been published for specific APIs on request from the product or engineering teams. The documentation is not regularly maintained.

Resources

Documenting APIs: A wiki page that describes current and former documentation methods for edX APIs.

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.

/wiki/spaces/DOC/pages/113607066: Notes from a meeting with Ben Patterson and members of the documentation team about silent build failures in API documentation./wiki/spaces/DOC/pages/108659218: Wiki page of questions for Peter Desjardins, who was maintaining our API documentation before his departure in September. The first item is about API documentation.

Tools

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.