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

Research how to generate API Sphinx docs from OpenAPI/Swagger #628

Open
Tracked by #720
lunkwill42 opened this issue Apr 24, 2023 · 2 comments
Open
Tracked by #720

Research how to generate API Sphinx docs from OpenAPI/Swagger #628

lunkwill42 opened this issue Apr 24, 2023 · 2 comments
Assignees
Labels
API Affects Argus' REST API documentation Improvements or additions to documentation

Comments

@lunkwill42
Copy link
Member

The API documentation in Sphinx is currently manually maintained in parallel with the autogenerated Swagger docs. This should be unnecessary, as its best to maintain the documentation as close to the API definitions as possible. The current way of doing this is pretty much guaranteed to result in outdated documentation.

@lunkwill42 lunkwill42 added documentation Improvements or additions to documentation API Affects Argus' REST API labels Apr 24, 2023
@hmpf
Copy link
Contributor

hmpf commented Apr 28, 2023

I found sphinxcontrib-openapi, not tested.

@hmpf
Copy link
Contributor

hmpf commented Apr 28, 2023

Our schema needs to be improved a little, the "spectacular" management command has some complaints, I'll open a new issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Affects Argus' REST API documentation Improvements or additions to documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants