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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size sphinx_swagger-0.0.1-py2.py3-none-any.whl (7.5 kB) | File type Wheel | Python version 3.5 | Upload date | Hashes View |
Filename, size sphinx-swagger-0.0.1.tar.gz (5.6 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for sphinx_swagger-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1eb4ca2ff7551e74ac0a58f715edc60ad07b4e961a8f70bdaa106695a98a8af |
|
MD5 | 0b9af5d93e08c3970f49a94fe94a037c |
|
BLAKE2-256 | 6545a3b75eb41d533a7506b278ff84e9f5790ab8d18c1eae112edd59331646a6 |