sphinx-swagger 0.0.1

Generate swagger definitions from sphinx docs

Generates a swagger API definition directly from httpdomain based documentation.

Usage

1. Enable the extension in your conf.py by adding 'sphinxswagger' to the extensions list

2. Run the swagger builder (e.g., setup.py build_sphinx -b swagger)

3. Use the generated swagger.json

Configuration

This extension contains a few useful configuration values:

swagger_file:

Sets the name of the generated swagger file. The file is always generated in the sphinx output directory – usually build/sphinx/swagger. The default file name is swagger.json.

swagger_license:

A dictionary that describes the license that governs the API. This is written as-is to the License section of the API document. It should contain two keys – name and url.