-
Notifications
You must be signed in to change notification settings - Fork 14
Open
Description
The edX API Documentation tools (GitHub, ReadTheDocs) are a flexible and friendly way to incrementally document HTTP APIs, allowing one to start with mostly auto-generated docs, and then use decorators to move towards fully-documented API catalogs.
Our previous strategy for generating API documentation (counting on Swagger to auto-parse the docstrings) is no longer supported.
Currently, at least edx-platform and Registrar use the library. (Registrar counts on the library to generate partner-facing API documentation). The edx-api-doc-tools library should be installed into the edx-cookiecutters so that it is available by default in new Django IDAs.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels