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 FastAPI-built OpenAPI docs to Sphinx docs #82

Open
1 task
jsstevenson opened this issue Jan 2, 2025 · 0 comments
Open
1 task

Add FastAPI-built OpenAPI docs to Sphinx docs #82

jsstevenson opened this issue Jan 2, 2025 · 0 comments
Labels
enhancement New feature or request priority:low Low priority

Comments

@jsstevenson
Copy link
Member

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.

@jsstevenson jsstevenson added enhancement New feature or request priority:low Low priority labels Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority:low Low priority
Projects
None yet
Development

No branches or pull requests

1 participant