Skip to main content

Sphinx "nwdiag" extension

Project description

====================
sphinxcontrib-nwdiag
====================

.. image:: https://travis-ci.org/blockdiag/sphinxcontrib-nwdiag.svg?branch=master
:target: https://travis-ci.org/blockdiag/sphinxcontrib-nwdiag

.. image:: https://coveralls.io/repos/blockdiag/sphinxcontrib-nwdiag/badge.png?branch=master
:target: https://coveralls.io/r/blockdiag/sphinxcontrib-nwdiag?branch=master

.. image:: https://codeclimate.com/github/blockdiag/sphinxcontrib-nwdiag/badges/gpa.svg
:target: https://codeclimate.com/github/blockdiag/sphinxcontrib-nwdiag

A sphinx extension for embedding network related diagrams using blockdiag_.

For now, nwdiag supports these diagrams:

- logical network diagram
- rack structure diagram
- packet structure diagram

This extension enables you to insert network related diagrams into your document.
Following code is an example::

.. nwdiag::

nwdiag {
network {
web01; web02;
}
network {
web01; web02; db01;
}
}

.. _nwdiag: http://bitbucket.org/blockdiag/nwdiag/


For more details, see `online documentation`_ at http://blockdiag.com/.

.. _online documentation: http://blockdiag.com/en/nwdiag/sphinxcontrib.html

Project details


Download files

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

Source Distribution

sphinxcontrib-nwdiag-0.9.4.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_nwdiag-0.9.4-py2.py3-none-any.whl (26.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-nwdiag-0.9.4.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-nwdiag-0.9.4.tar.gz
Algorithm Hash digest
SHA256 a4131a926af0f354271ffebfe00fd0abafbf74f020e9e1b3ddaff823150120ba
MD5 6dd845c2810344e7e5bb43ce6222c9b4
BLAKE2b-256 59d472f063ee39168d82225fb981b9d77a338bab5f624a6e9f7c05eefe9f26f4

See more details on using hashes here.

File details

Details for the file sphinxcontrib_nwdiag-0.9.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_nwdiag-0.9.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 61efecfda645398ba3ece046bbe205e8684af03e467768f13a37368c24ffc1ce
MD5 b8560385c8f889796c4defed85ae2439
BLAKE2b-256 436a5d82a5cbd75007b4a79debec32320b16bce90493447d356c86541498e22a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page