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
Project details
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 Distributions
Hashes for asyncapi-sphinx-ext-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f22fe54b5b81e066c156a12f0dca1c19b9f18fdd4704d6a0dda657c78052dc41 |
|
MD5 | 135189669a1106337c5bd25a537d3019 |
|
BLAKE2b-256 | 2ae267d18b15958336f63d1f62d0181fd00f4ce6fa4e4578e28b4ac25c2afd3a |
Hashes for asyncapi_sphinx_ext-1.0.1-py3.6.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9e7d084ece6abe1ff9d6f6d2d371f8f5616ad9c3d3f769062a5ea74a3c8f60d |
|
MD5 | f6f0dd72816be5987d1541c0f8deb80a |
|
BLAKE2b-256 | fb1a713eca3f6a135b71bb691af73020c6bf4308068da8e64d7a60b3afae601a |
Hashes for asyncapi_sphinx_ext-1.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c62bad8df2128626457efafcfaff66348fb596988959a6a874812277d5005a87 |
|
MD5 | 57fcba0d0ee8167cb5e63c80512a0dac |
|
BLAKE2b-256 | 20ab104a99249872b2a272403e0de852ce6ba4ab6160424aabbe511bae218fd8 |