Date: Fri, 29 Mar 2024 13:39:02 +0000 (UTC) Message-ID: <1625103633.9.1711719542493@945b39bfea8c> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_8_1455687539.1711719542493" ------=_Part_8_1455687539.1711719542493 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
API documentation covers a small number of the edX APIs. Because= edX has not had an overall API strategy, only a few APIs are documented, a= nd the criteria that make documentation mandatory for a specific API are un= clear. Additionally, the current API documentation is very fragile and can = break anytime a developer adds a module to the edx-platform repository. For= the past year, the documentation team has wanted to find an alternative wa= y to publish API documentation. However, because edX doesn't yet have an ov= erall API strategy, the documentation team has halted progress on API docum= entation work.
External clients, IDA users
All
API documentation has been published for specific APIs on request from t= he product or engineering teams. The documentation is not regularly maintai= ned.
Documenting APIs: A wiki page that describes curr= ent and former documentation methods for edX APIs.
Sphinx Autodoc Content: A wiki page with a s= tep-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 P= atterson and members of the documentation team about silent build failures = in API documentation.
API documentation tools have historically used .rst files, Python docstr= ings together with the Sphinx autodoc extension, GitHub, and ReadTheDocs. F= or more information, see Documenting APIs = and Sphinx Autodoc Content.