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.

Sign up for GitHub

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

Jump to bottom

Add falcon support to sphinxcontrib-httpdomain #1355

Open
carlodri opened this issue Sep 25, 2018 · 2 comments
Open

Add falcon support to sphinxcontrib-httpdomain #1355

carlodri opened this issue Sep 25, 2018 · 2 comments
Labels
community needs contributor Comment on this issue if you'd like to volunteer to work on this. Thanks!
Milestone
Triaged (Non-Brea...

Comments

@carlodri
Copy link
Contributor

It would be truly helpful if an autohttp paser was added to sphinxcontrib.httpdomain in order to automatically generate HTTP API documentation from falcon sources, similarly to what already exists for flask, tornado and bottle.

I'm just referencing here this issue on sphinxcontrib-httpdomain to gather some interest and attention. I've tried to look a the sources for the autohttp directive of the other frameworks but honestly I'm having a hard time understanding the working principle. Maybe for someone who's a little deeper in sphinx-stuff it could be a simple task.
@vytas7
Copy link
Member

vytas7 commented Dec 28, 2018 •
edited
Loading

That would definitely be nice to have.
Not sure we can spare the bandwidth to prioritize this right now, but contributors are very welcome on this one!

@vytas7 vytas7 added the needs contributor Comment on this issue if you'd like to volunteer to work on this. Thanks! label Dec 28, 2018
@vytas7
Copy link
Member

vytas7 commented Oct 9, 2021 •
edited
Loading

If this gets implemented on sphinxcontrib-httpdomain's side, we'd be more than happy to accept a PR advertising support as a FAQ item or a recipe in our docs.

@vytas7 vytas7 changed the title add falcon support to sphinxcontrib-httpdomain Add falcon support to sphinxcontrib-httpdomain Oct 10, 2021
@vytas7 vytas7 added this to the Triaged (Non-Breaking Changes) milestone Jan 8, 2023
@vytas7 vytas7 mentioned this issue Jun 3, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
community needs contributor Comment on this issue if you'd like to volunteer to work on this. Thanks!
Projects
None yet
Milestone
Triaged (Non-Breaking Changes)
Development

No branches or pull requests
2 participants
@vytas7 @carlodri