{"id":24633,"library":"sphinxcontrib-nwdiag","title":"Sphinx nwdiag Extension","description":"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.","status":"maintenance","version":"2.0.0","language":"python","source_language":"en","source_url":"https://github.com/blockdiag/sphinxcontrib-nwdiag","tags":["sphinx","extension","nwdiag","network-diagram","blockdiag"],"install":[{"cmd":"pip install sphinxcontrib-nwdiag","lang":"bash","label":"pip install"}],"dependencies":[{"reason":"Required extension framework","package":"Sphinx","optional":false},{"reason":"Required rendering backend","package":"blockdiag","optional":false},{"reason":"Required diagram library","package":"nwdiag","optional":false}],"imports":[{"wrong":"from sphinxcontrib import nwdiag","symbol":"nwdiag","correct":"import sphinxcontrib.nwdiag"}],"quickstart":{"code":"# conf.py\nextensions = ['sphinxcontrib.nwdiag']\n\n# index.rst\n.. nwdiag::\n\n   nwdiag {\n     network dmz {\n         address = \"210.x.x.x/24\"\n         web01 [address = \"210.x.x.1\"];\n         web02 [address = \"210.x.x.2\"];\n     }\n     network internal {\n         web01;\n         web02;\n         db01;\n         db02;\n     }\n   }","lang":"python","description":"Add extension to conf.py and use nwdiag directive in reStructuredText."},"warnings":[{"fix":"Upgrade to 2.0.0 and pin Sphinx < 4.0 if necessary.","message":"Sphinx 4.0+ drops Python 2.7/3.5 support; sphinxcontrib-nwdiag requires blockdiag and nwdiag which may have compatibility issues with newer Sphinx.","severity":"broken","affected_versions":"sphinxcontrib-nwdiag < 2.0.0"},{"fix":"Set 'html' builder in conf.py: html_builder = 'html'","message":"The nwdiag directive does not work with Sphinx's 'dirhtml' builder (creates nested directories). Use 'html' builder instead.","severity":"gotcha","affected_versions":"all"},{"fix":"Use Python 3.5+.","message":"Python 2.7 support is deprecated. blockdiag and nwdiag libraries no longer receive updates for Python 2.","severity":"deprecated","affected_versions":"< 2.0.0"}],"env_vars":null,"search_vec":"'2.0.0':17 '2.7':27 '2018':20 '3':29 'blockdiag':14,37 'diagram':10,11,36 'emb':7 'extens':3,5,32 'famili':15 'januari':19 'maintain':21 'mainten':23 'mode':24 'network':9,35 'network-diagram':34 'nwdiag':2,8,33 'python':26 'releas':18 'sphinx':1,4,31 'support':25 'use':12 'version':16 'x':30","created_at":"2026-05-01T08:14:07.390249+00:00","updated_at":"2026-05-01T08:14:07.390249+00:00","problems":{"verify_error":"Traceback (most recent call last):\n  File \"<string>\", line 1, in <module>\n  File \"/tmp/tmpur336jo7/venv/lib/python3.12/site-packages/sphinxcontrib/nwdiag.py\", line 19, in <module>\n    import pkg_resources\nModuleNotFoundError: No module named 'pkg_resources'"},"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"2.0.0","cli_name":"","cli_version":null,"type":"library","homepage":null,"github":"http://github.com/blockdiag/sphinxcontrib-nwdiag","docs":null,"changelog":null,"pypi":"https://pypi.org/project/sphinxcontrib-nwdiag/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["web-framework"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"import_fail","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-07-10","install_tag":null}}