Converter from Swagger to Sphinx HTTP domain.
Swagger is an open specification for documenting REST APIs in JSON or YAML. Imperfect as it is, it’s de facto a standard for many API developers.
This extension was created for a particular project and thus is only guaranteed to work with this particular project! It is very much likely you’ll have to modify swagger-api.rst for your project.
Install the extension:
$ pip install sphinxcontrib-swagger2sphinx
Copy the content of swagger-api.rst to the file where you want your Swagger file rendered.
Add the extension to your conf.py:
extensions = [ 'sphinxcontrib.swagger2sphinx', ... ]
Specify the path to your Swagger file in conf.py. It can be a local path or a URL:
swagger2sphinx_swagger_location = "swagger.json" # swagger2sphinx_swagger_location = "http://example.com/swagger.json"
Thanks to Eric Holscher for writing an excellent blog post about extending Sphinx with Jinja2 templating.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size sphinxcontrib_swagger2sphinx-0.1.4-py3-none-any.whl (4.7 kB)||File type Wheel||Python version 3.5||Upload date||Hashes View hashes|
Hashes for sphinxcontrib_swagger2sphinx-0.1.4-py3-none-any.whl