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.3.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_nwdiag-0.9.3-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.3.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-nwdiag-0.9.3.tar.gz
Algorithm Hash digest
SHA256 ae469a59be7293e2bfdaf02871442f1d39e2e269fe6c46a409e2e68b9d97e616
MD5 b0f3097311f303c863fa4147c0af68ab
BLAKE2b-256 37bbcb7faa028081b69c5ef89b2887145e49aced3622e2fec8fd79c854445bd5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinxcontrib_nwdiag-0.9.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1b1828cf2caf9956591af35bbc3c636d7d25e3af4cff42e23d5ef4db2e82e271
MD5 83d5594fe3eca9bd0178ec3c13da36a9
BLAKE2b-256 a2c1b6f847fc292e703e58b9c0a648087a44516d8266149d9407052bdcdf1b53

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