Add FastAPI-built OpenAPI docs to Sphinx docs #82
Description
Feature description
This tool lets you embed an openapi.json file in Sphinx docs: https://github.com/sphinx-contrib/openapi?tab=readme-ov-file
Of course, with FastAPI, we generate openapi.json dynamically. I think it would be doable to hook construction of the json into the docs build workflow but I'm a little woozy on doing this in #78 so I'm pinning it for later.
Use case
Auto generated documentation for API endpoints is helpful
Acceptance Criteria
- A workflow for RTD-hosted Sphinx docs that automatically generates and embeds docs for FastAPI endpoints
Proposed solution
No response
Alternatives considered
No response
Implementation details
No response
Potential Impact
No response
Additional context
No response
Contribution
Yes, I can create a PR for this feature.