Skip to content

mortbauer/asyncapi-sphinx-ext

Repository files navigation

AsyncAPI Sphinx Extension

PyPI - Python Version

Package on PyPI

Travis (.org)

image

Number of PyPI downloads

Wheel Status

Read the Docs

This extension adds some directives to integrate documentation for your pub-sub application using asyncapi specification.

You can use asyncapi specifications in your source code doc string or in your documentation to generate a beautiful documentation plus overview. Further the specification might be used for other things as well (not supported yet).

Warning

This is still in a early stage.

Installation

Install the sphinx extension with pip install asyncapi_sphinx_ext.

Usage

The extension adds two directives asyncapi_channels and asyncapi_overview.

The asyncapi_channels directive is used to add the some pub/sub documentation and the asyncapi_overview is used to create a table with the all the pub/sub topics defined.

For a full example checkout usage_example.

source

https://github.com/mortbauer/asyncapi-sphinx-ext

documentation

https://asyncapi-sphinx-ext.readthedocs.org/en/latest/

pypi

https://pypi.org/project/asyncapi-sphinx-ext/

About

AsyncAPI Sphinx Extension to document your pub/sub endpoints

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages