Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add edx-api-doc-tools to edx-cookiecutters #160

Open
jristau1984 opened this issue Oct 24, 2022 · 1 comment
Open

Add edx-api-doc-tools to edx-cookiecutters #160

jristau1984 opened this issue Oct 24, 2022 · 1 comment

Comments

@jristau1984
Copy link

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.

@kdmccormick
Copy link
Member

kdmccormick commented Oct 24, 2022

FYI @ned @nedbat -- Jeremy copied this out of Jira for us.

I think this would be a good first task for whomever becomes this repository's maintainer. I personally think it would make sense for tCRIL to maintain this repo; when the time comes around I'll pitch it to my team, but I can't make any promises.

@kdmccormick kdmccormick added the good first issue A good task for a newcomer to start with label Oct 24, 2022
@kdmccormick kdmccormick removed the good first issue A good task for a newcomer to start with label Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants