Generate swagger definitions from sphinx docs
Project description
Generates a swagger API definition directly from httpdomain based documentation.
Usage
Enable the extension in your conf.py by adding 'sphinxswagger' to the extensions list
Run the swagger builder (e.g., setup.py build_sphinx -b swagger)
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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_swagger-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51d90861412a7c5580db8cf98d642ca29ede581c18251a86fceb86406b676fe2 |
|
MD5 | cfbf5dc5c0ad69f0fe2cfcdb37b9f3c5 |
|
BLAKE2b-256 | c61c6be0cca01be187754dc32d5b389c261d4c0ee4333a89432d239a110db7f8 |