Generate swagger definitions from sphinx docs
Generates a swagger API definition directly from httpdomain based documentation.
- 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
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.|
|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.|
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size sphinx_swagger-0.0.2-py3-none-any.whl (7.7 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size sphinx-swagger-0.0.2.tar.gz (5.8 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for sphinx_swagger-0.0.2-py3-none-any.whl