Skip to content

Sphinx extension that automatically documents Swagger APIs

License

Notifications You must be signed in to change notification settings

CantemoInternal/sphinx-swagger

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sphinx-swagger

Sphinx extension that automatically documents Swagger APIs

Usage

Include extension in conf.py

extensions = ['sphinx_swagger']

Add directive pointin to Swagger api-docs

.. swaggerdoc:: URL

For example

.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/pet

.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/user

.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/store

About

Sphinx extension that automatically documents Swagger APIs

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%