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
Release files for asyncapi-sphinx-ext 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| asyncapi-sphinx-ext-1.0.2.tar.gz | 5.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| asyncapi_sphinx_ext-1.0.2-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 13.3 kB
Release files / asyncapi-sphinx-ext-1.0.2.tar.gz
| Download URL | asyncapi-sphinx-ext-1.0.2.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9749ffd8266a8dfa17a3f46f188b886e685c8bcc24376dcd9cafba11bb032e07
|
|
BLAKE2b-256 checksum How to use checksums |
3b1bd10a6643ea7d0bb2db4c68ad895cbdd1637c45d21e9c6027ad1b7764507c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / asyncapi_sphinx_ext-1.0.2-py2-none-any.whl
| Download URL | asyncapi_sphinx_ext-1.0.2-py2-none-any.whl |
|---|---|
| Size | 7.7 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
295e6beb172589364f7bf93300578185a4d08c6910f64bcc5d0a8711a37a409f
|
|
BLAKE2b-256 checksum How to use checksums |
f51cbfb01884ff5c140acc983b7251495ef0657e2c4a25ff989664b70f5774f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
