Skip to main content

Sphinx "nwdiag" extension

Project description

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

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

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

.. image:: https://codeclimate.com/github/tk0miya/sphinxcontrib-nwdiag/badges/gpa.svg
:target: https://codeclimate.com/github/tk0miya/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.2.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_nwdiag-0.9.2-py2.py3-none-any.whl (26.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sphinxcontrib-nwdiag-0.9.2.tar.gz
Algorithm Hash digest
SHA256 d407af1dc2ed3afa31cdb1ee35c0a32b3ad4cbdc8e6a64088d0fd685225241ef
MD5 738f34244f0d4fdad4ac4fa8ef0aa960
BLAKE2b-256 d31c01700dc5bc29b5df8351902409b4da9d45a7a5d30d263294d5155d8ca3b9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinxcontrib_nwdiag-0.9.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 56ff9c7108ee85c07f713ed966366e42d35305424a6c2a7636c5269cbeabf176
MD5 54ba2dd741355696f02c69f4439b4baa
BLAKE2b-256 6ad31dfbf8239a0411ff8c3381460efb212ef1e09591829d887ea7592087d99a

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