Versions Compared

Key

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

...

External clients, IDA users

Products

All

Frequency

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

Resources

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

...

/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.

Frequency

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

Tools

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