search

falconry / falcon

The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.
https://falcon.readthedocs.io/en/stable/
Apache License 2.0
9.53k stars 945 forks source link

Add falcon support to sphinxcontrib-httpdomain #1355

Open carlodri opened 6 years ago

carlodri commented 6 years ago

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 commented 5 years ago

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 commented 3 years ago

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.