sphinx-contrib / nwdiag /

Filename Size Date modified Message
37 B
1.4 KB
65 B
2.2 KB
83 B
1.8 KB
868 B

nwdiag extension README

This is a sphinx extension which render network diagrams by using nwdiag .



.. nwdiag::

   diagram {
     network {
       web01; web02;
     network {
       web01; web02; db01;


You can get archive file at http://bitbucket.org/birkenfeld/sphinx-contrib/

Required components


> easy_install sphinxcontrib-nwdiag

Configure Sphinx

To enable this extension, add sphinxcontrib.nwdiag module to extensions option at :file:`conf.py`.

import os, sys

# Path to the folder where nwdiag.py is
# NOTE: not needed if the package is installed in traditional way
# using setup.py or easy_install

# Enabled extensions
extensions = ['sphinxcontrib.nwdiag']


Configuration File Options


This code is hosted by Bitbucket.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.