Registry / web-framework / sphinxcontrib-nwdiag

sphinxcontrib-nwdiag

JSON →
library2.0.0pypypiunverified

Sphinx extension to embed nwdiag (network diagram) diagrams using the blockdiag family. Version 2.0.0 released January 2018; maintained in maintenance mode. Supports Python 2.7+ and 3.x.

web-framework
pip install sphinxcontrib-nwdiag
github ↗package ↗
INSTALL
IMPORT
SIG · SPHINXCONTRIB-NWDI
S
sphinxcontrib-nwdiag
web-frameworkpythonv2.0.0
Install
6.8s avg
Import
693ms
Disk
137MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.9–3.13
musl
3.9–3.13
Install & Compatibility
Where this runs
tested against v2.0.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.442s · 130.6MB
glibc
py 3.10–3.95 runs
installs and imports cleanly · install 6.8s · import 0.390s · 132MB
137MB installed
● package 137MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

nwdiag
✓ import sphinxcontrib.nwdiag
✗ from sphinxcontrib import nwdiag

Add extension to conf.py and use nwdiag directive in reStructuredText.

# conf.py extensions = ['sphinxcontrib.nwdiag'] # index.rst .. nwdiag:: nwdiag { network dmz { address = "210.x.x.x/24" web01 [address = "210.x.x.1"]; web02 [address = "210.x.x.2"]; } network internal { web01; web02; db01; db02; } }
Debug
Known issues
brokenSphinx 4.0+ drops Python 2.7/3.5 support; sphinxcontrib-nwdiag requires blockdiag and nwdiag which may have compatibility issues with newer Sphinx.
fix
Upgrade to 2.0.0 and pin Sphinx < 4.0 if necessary.
affects: sphinxcontrib-nwdiag < 2.0.0
gotchaThe nwdiag directive does not work with Sphinx's 'dirhtml' builder (creates nested directories). Use 'html' builder instead.
fix
Set 'html' builder in conf.py: html_builder = 'html'
affects: all
deprecatedPython 2.7 support is deprecated. blockdiag and nwdiag libraries no longer receive updates for Python 2.
fix
Use Python 3.5+.
affects: < 2.0.0
Upgrade
Version history
2.0.0latest on PyPI · released Dec 10, 2019
Audit
Dependencies
SphinxrequiredRequired extension framework
blockdiagrequiredRequired rendering backend
nwdiagrequiredRequired diagram library
Agent activity
7 hits · last 30 days
node
6
Resources
githubhttp://github.com/blockdiag/sphinxcontrib-nwdiag ↗
packagehttps://pypi.org/project/sphinxcontrib-nwdiag/ ↗
sphinxcontrib-nwdiag — pip install sphinxcontrib-nwdiag · libregistry