Skip to main content

Sphinx extension for Pub/Sub Documentation

Project description

PyPI - Python Version Package on PyPI Travis (.org) https://coveralls.io/repos/asyncapi-sphinx-ext/sphinx-testing/badge.png?branch=master 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for asyncapi-sphinx-ext, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size asyncapi_sphinx_ext-1.0.2-py2-none-any.whl (7.7 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size asyncapi-sphinx-ext-1.0.2.tar.gz (5.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page