personal web log written by izabeera and dryobates

sphinx httpdomain rest

Documenting Flask REST API in Sphinx

Many REST frameworks have built in documentation for provided API. Many specialized software exists for centralized API documentation. But if all you need is to include documentation for your project in your regular sphinx documentation then sphinxcontrib-httpdomain can be helpful.

11 Oct 2016 by dryobates

dryobates
dryobates
Jakub Stolarski. Software engineer. I work professionally as programmer since 2005. Speeding up software development with Test Driven Development, task automation and optimization for performance are things that focus my mind from my early career up to now. If you ask me for my religion: Python, Vim and FreeBSD are my trinity ;) Email: jakub@stolarscy.com

Archive

Tag cloud