Sphinx extension for Pub/Sub Documentation
Project description
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).
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.
Important Links
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for asyncapi-sphinx-ext-1.0.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9749ffd8266a8dfa17a3f46f188b886e685c8bcc24376dcd9cafba11bb032e07 |
|
| MD5 | 75ff32b1aafb196e990158c38d0b9284 |
|
| BLAKE2b-256 | 3b1bd10a6643ea7d0bb2db4c68ad895cbdd1637c45d21e9c6027ad1b7764507c |
Hashes for asyncapi_sphinx_ext-1.0.2-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 295e6beb172589364f7bf93300578185a4d08c6910f64bcc5d0a8711a37a409f |
|
| MD5 | 99625d20a3110cbed39db0884c9109e4 |
|
| BLAKE2b-256 | f51cbfb01884ff5c140acc983b7251495ef0657e2c4a25ff989664b70f5774f4 |
