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

Automate API documentation generation with GitHub Actions #3278

Closed
Tracked by #2888
varshadr opened this issue Oct 31, 2023 · 0 comments
Closed
Tracked by #2888

Automate API documentation generation with GitHub Actions #3278

varshadr opened this issue Oct 31, 2023 · 0 comments
Assignees
Labels
ready Ready for implementation type: enhancement New feature or request work: documentation Improvements or additions to documentation
Milestone

Comments

@varshadr
Copy link
Contributor

varshadr commented Oct 31, 2023

Problem

Currently, the API documentation is not generated automatically for pull requests. Therefore, API documentation may not be up-to-date

Proposed solution

Add a GitHub Actions workflow to generate the API documentation for pull requests to the develop branch. The workflow should build a Docker image, run the ./manage.py spectacular --color --file schema.yml
command to generate the API documentation, and commit the schema file to the branch.

@varshadr varshadr self-assigned this Oct 31, 2023
@varshadr varshadr added work: documentation Improvements or additions to documentation type: enhancement New feature or request status: started labels Oct 31, 2023
@varshadr varshadr added this to the GSoC 2023 milestone Oct 31, 2023
@varshadr varshadr linked a pull request Nov 2, 2023 that will close this issue
7 tasks
@seancolsen seancolsen added ready Ready for implementation and removed status: started labels Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready Ready for implementation type: enhancement New feature or request work: documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants