# sphinx-swagger-doc

**Repository Path**: mirrors_codejamninja/sphinx-swagger-doc

## Basic Information

- **Project Name**: sphinx-swagger-doc
- **Description**: Sphinx extension for documenting Swagger 2.0 APIs
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sphinx-swagger-doc

[![Beerpay](https://beerpay.io/jamrizzi/sphinx-swagger-doc/badge.svg?style=beer-square)](https://beerpay.io/jamrizzi/sphinx-swagger-doc)
[![Beerpay](https://beerpay.io/jamrizzi/sphinx-swagger-doc/make-wish.svg?style=flat-square)](https://beerpay.io/jamrizzi/sphinx-swagger-doc?focus=wish)
[![GitHub stars](https://img.shields.io/github/stars/jamrizzi/sphinx-swagger-doc.svg?style=social&label=Stars)](https://github.com/jamrizzi/sphinx-swagger-doc)

> Sphinx extension for documenting Swagger 2.0 APIs

Please ★ this repo if you found it useful ★ ★ ★

![](assets/sphinx-swagger-doc.png)

## Features

* Swagger 2.0 spec
* Generate sphinx doc


## Installation

```sh
pip install sphinx-swagger-doc
```


## Dependencies

* [Python](https://www.python.org)
* [Sphinx](http://www.sphinx-doc.org)


## Usage

[Contribute](https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md) usage docs


## Support

Submit an [issue](https://github.com/jamrizzi/sphinx-swagger-doc/issues/new)


## Screenshots

[Contribute](https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md) a screenshot


## Contributing

Review the [guidelines for contributing](https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md)


## License

[MIT License](https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/LICENSE)

[Jam Risser](https://jamrizzi.com) © 2018


## Changelog

Review the [changelog](https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CHANGELOG.md)


## Credits

* [Jam Risser](https://jamrizzi.com) - Author


## Support on Beerpay (actually, I drink coffee)

A ridiculous amount of coffee :coffee: :coffee: :coffee: was consumed in the process of building this project.

[Add some fuel](https://beerpay.io/jamrizzi/sphinx-swagger-doc) if you'd like to keep me going!

[![Beerpay](https://beerpay.io/jamrizzi/sphinx-swagger-doc/badge.svg?style=beer-square)](https://beerpay.io/jamrizzi/sphinx-swagger-doc)
[![Beerpay](https://beerpay.io/jamrizzi/sphinx-swagger-doc/make-wish.svg?style=flat-square)](https://beerpay.io/jamrizzi/sphinx-swagger-doc?focus=wish)