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
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file asyncapi-sphinx-ext-1.0.2.tar.gz.
File metadata
- Download URL: asyncapi-sphinx-ext-1.0.2.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9749ffd8266a8dfa17a3f46f188b886e685c8bcc24376dcd9cafba11bb032e07
|
|
| MD5 |
75ff32b1aafb196e990158c38d0b9284
|
|
| BLAKE2b-256 |
3b1bd10a6643ea7d0bb2db4c68ad895cbdd1637c45d21e9c6027ad1b7764507c
|
File details
Details for the file asyncapi_sphinx_ext-1.0.2-py2-none-any.whl.
File metadata
- Download URL: asyncapi_sphinx_ext-1.0.2-py2-none-any.whl
- Upload date:
- Size: 7.7 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
295e6beb172589364f7bf93300578185a4d08c6910f64bcc5d0a8711a37a409f
|
|
| MD5 |
99625d20a3110cbed39db0884c9109e4
|
|
| BLAKE2b-256 |
f51cbfb01884ff5c140acc983b7251495ef0657e2c4a25ff989664b70f5774f4
|
