{ "info": { "author": "Michal Orsak", "author_email": "michal.o.socials@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Plugins", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)", "Topic :: System :: Hardware", "Topic :: Utilities" ], "description": "# sphinx-hwt\n\n[![Travis-ci Build Status](https://travis-ci.org/Nic30/sphinx-hwt.png?branch=master)](https://travis-ci.org/Nic30/sphinx-hwt)[![PyPI version](https://badge.fury.io/py/sphinx-hwt.svg)](http://badge.fury.io/py/sphinx-hwt)[![Coverage Status](https://coveralls.io/repos/github/Nic30/sphinx-hwt/badge.svg?branch=master)](https://coveralls.io/github/Nic30/sphinx-hwt?branch=master)[![Documentation Status](https://readthedocs.org/projects/sphinx-hwt/badge/?version=latest)](http://sphinx-hwt.readthedocs.io/en/latest/?badge=latest)\n[![Python version](https://img.shields.io/pypi/pyversions/sphinx-hwt.svg)](https://img.shields.io/pypi/pyversions/sphinx-hwt.svg)\n\nExtension for Sphinx document generator. Add automatically generated schemes and other visual documentation of hardware.\nCurrently mainly for [HWT library](https://github.com/Nic30/hwt.git) (but VHDL,Verilog -> HWT is possible).\n\nLive demo is documentation of [hwtLib library](https://github.com/Nic30/hwtLib), this library contains many components. The schematic is in documentation of compoents for example there in documentation of [CRC generator](http://hwtlib.readthedocs.io/en/latest/_static/schematic_viewer/schematic_viewer.html?schematic=../../_static/hwt_schematics/hwtLib.logic.crc.Crc.json).\n\n\n## Installation\nInstall as standard python package, using pip. If you have NPM installed javascript in package will be updated.\n```\npip3 install sphinx-hwt\n```\n\nsphinx-hwt package provides sphinx_hwt extension for sphinx doc. gen. In order to use this extension you have to register in in your conf.py sphinx doc. configuration.\n\n``` python\nextensions = ['sphinx_hwt']\n```\n\nFrom now Sphinx will be able to use directives from sphinx-hwt to render schematics and others.\n\n\n\n## Usage\n\nAdd hwt-schematic directive in docstring of Unit class like this.\n\n```python\nfrom hwt.synthesizer.unit import Unit\n\nclass ExampleCls0(Unit):\n \"\"\"\n .. hwt-schematic::\n \"\"\"\n```\n\nLink on schematic will be added to class documentation.\n\n\n\n## Feature list\n* generate interactive schematic for Unit instances (= module in verilog, entity + architecutere in VHDL).\n * zoom, pan, dynamic colapsing, net-select, searching and filtering\n * schematic rendered by [d3-hwschematic library](https://github.com/Nic30/d3-hwschematic)\n * Unit instances to graph conversion by [hwtGraph library](https://github.com/Nic30/hwtGraph)\n\n## Near feature list (will add in 2018-8-xx)\n* signal waves by [d3-wave library](https://github.com/Nic30/d3-wave)", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Nic30/sphinx-hwt", "keywords": "sphinx documentation HWT FPGA hardware VHDL System Verilog schematic wave", "license": "BSD-3-Clause", "maintainer": "", "maintainer_email": "", "name": "sphinx-hwt", "package_url": "https://pypi.org/project/sphinx-hwt/", "platform": "", "project_url": "https://pypi.org/project/sphinx-hwt/", "project_urls": { "Homepage": "https://github.com/Nic30/sphinx-hwt" }, "release_url": "https://pypi.org/project/sphinx-hwt/1.6/", "requires_dist": null, "requires_python": "", "summary": "Sphinx extension to produce interactive schematic for hardware writen in HWT", "version": "1.6" }, "last_serial": 4302298, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "46d33b6cff9cf2514957b929b066db99", "sha256": "44f3b465ba06732c936e8932ac603344ee2d95b71307a0779187bbc592b49379" }, "downloads": -1, "filename": "sphinx-hwt-0.1.tar.gz", "has_sig": false, "md5_digest": "46d33b6cff9cf2514957b929b066db99", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8152, "upload_time": "2018-08-01T21:54:28", "url": "https://files.pythonhosted.org/packages/dc/e6/07868498167b66e5d9a132a654f60fbcb9f81e419f673e207832dc27b924/sphinx-hwt-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "fc41da0514937da1e267afe364ab459c", "sha256": "6ef6e129815cc4830d000ea7c1c161d7ea0d6a661ab5996508dfe895a079046b" }, "downloads": -1, "filename": "sphinx-hwt-0.2.tar.gz", "has_sig": false, "md5_digest": "fc41da0514937da1e267afe364ab459c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8185, "upload_time": "2018-08-01T22:35:31", "url": "https://files.pythonhosted.org/packages/e4/d7/7f94c2f6851b296746727ce8bd8eefb9ba359107c9275b6ace4d2a65e88e/sphinx-hwt-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "327b74a56d126aeb0e2851bb0da53b84", "sha256": "ac47acdd1608a5430fe01dc4c928500c2ccd5fa518071d53df9a93b0771a56d6" }, "downloads": -1, "filename": "sphinx-hwt-0.3.tar.gz", "has_sig": false, "md5_digest": "327b74a56d126aeb0e2851bb0da53b84", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8819, "upload_time": "2018-08-02T07:31:59", "url": "https://files.pythonhosted.org/packages/63/f2/b3c295ba895e56438c6b571bdb07f2c5c6845ea0b51524a5996440f2cc3e/sphinx-hwt-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "250a9b2028c1ff74fd5d495be07c5d10", "sha256": "ad55a82e0bb7078280f499d0b2012729d8795317fc679ea6efff408dd6c30297" }, "downloads": -1, "filename": "sphinx-hwt-0.4.tar.gz", "has_sig": false, "md5_digest": "250a9b2028c1ff74fd5d495be07c5d10", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8855, "upload_time": "2018-08-02T07:43:41", "url": "https://files.pythonhosted.org/packages/44/99/cd81154909a2b81efbdc6c34abbf2c23af70c2c14a69bc8dbb179cdd18b5/sphinx-hwt-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "edde349f6d18e9fcfb154bd5091a28c7", "sha256": "431dcf6bbf2b5975f512291c697ff922333dfe71660606512df939d26e9cb568" }, "downloads": -1, "filename": "sphinx-hwt-0.5.tar.gz", "has_sig": false, "md5_digest": "edde349f6d18e9fcfb154bd5091a28c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8884, "upload_time": "2018-08-02T08:12:44", "url": "https://files.pythonhosted.org/packages/11/00/85083c12655c762df9844adf3feb8bec5bd2c61aaab50cd48da4b019c4d6/sphinx-hwt-0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "fd9a23039a9dc377f71549d2eb54fe09", "sha256": "4063a95adcba0cf476f59d4e6c4764d2a75f9e03abdf954a462cce676832a0b2" }, "downloads": -1, "filename": "sphinx-hwt-0.6.tar.gz", "has_sig": false, "md5_digest": "fd9a23039a9dc377f71549d2eb54fe09", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8983, "upload_time": "2018-08-02T08:32:40", "url": "https://files.pythonhosted.org/packages/22/10/a4d244583eec684dfae8eeb863616a04aafe180f5138d78e7d4945d7ff1f/sphinx-hwt-0.6.tar.gz" } ], "0.7": [ { "comment_text": "", "digests": { "md5": "d8f30b0e39f086f9242a710acc3a2fba", "sha256": "70b74f0b231a80118ffd37ec3de274b8e49e393efde83676c734993086c689eb" }, "downloads": -1, "filename": "sphinx-hwt-0.7.tar.gz", "has_sig": false, "md5_digest": "d8f30b0e39f086f9242a710acc3a2fba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 755096, "upload_time": "2018-08-02T09:10:56", "url": "https://files.pythonhosted.org/packages/d4/6b/d42d518016e891b415c61cfb8fa675c5dd161f6951c7c67ef04d9838baba/sphinx-hwt-0.7.tar.gz" } ], "0.8": [ { "comment_text": "", "digests": { "md5": "49e948f7f998936956de0385cc227f09", "sha256": "d030c0beb32f52fd984b3e68a65edbb735639dbefd3e033fdcb987ff5067d990" }, "downloads": -1, "filename": "sphinx-hwt-0.8.tar.gz", "has_sig": false, "md5_digest": "49e948f7f998936956de0385cc227f09", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 755196, "upload_time": "2018-08-02T14:53:09", "url": "https://files.pythonhosted.org/packages/bb/da/428b345bfeb6468b226594864fc6b90de64a500a6d5a3d637c5f80541c2c/sphinx-hwt-0.8.tar.gz" } ], "0.9": [ { "comment_text": "", "digests": { "md5": "3f33931dbdc2f2e4473f580b74ddf875", "sha256": "ce8f2b269e655e4168a3e054a7d64796ae6372c91bce2a73a22debd36182477f" }, "downloads": -1, "filename": "sphinx-hwt-0.9.tar.gz", "has_sig": false, "md5_digest": "3f33931dbdc2f2e4473f580b74ddf875", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 755238, "upload_time": "2018-08-02T15:49:33", "url": "https://files.pythonhosted.org/packages/5b/0a/f37c1efa3cf8251cc489c231354e651baf2a049be8c25979ab294d86c1f3/sphinx-hwt-0.9.tar.gz" } ], "1.0": [ { "comment_text": "", "digests": { "md5": "6dd45d461435e8cba5e08e4b5f168b1f", "sha256": "1bd59d2cac473515bcffaf73395a15edd832aa0b85bae72c3322ca4f88a15a28" }, "downloads": -1, "filename": "sphinx-hwt-1.0.tar.gz", "has_sig": false, "md5_digest": "6dd45d461435e8cba5e08e4b5f168b1f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 758373, "upload_time": "2018-08-08T13:49:15", "url": "https://files.pythonhosted.org/packages/9f/d4/4ec61ab54a3650869fd3b0f2ad837fd78da80cd5cd5da2734eca5e9d79c7/sphinx-hwt-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "82795dc3df98ebc7e880cecfb4dda0c3", "sha256": "0cecc9b67f1d928947262e38372ac9c15cce4ce587c055fbd2c3576e092c9799" }, "downloads": -1, "filename": "sphinx-hwt-1.1.tar.gz", "has_sig": false, "md5_digest": "82795dc3df98ebc7e880cecfb4dda0c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 759876, "upload_time": "2018-09-02T10:41:50", "url": "https://files.pythonhosted.org/packages/41/ca/5ee337443faf357d495275f283c8cbcd0f98df621ff50e2c3aa7b98d6f71/sphinx-hwt-1.1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "4b649ceca9848639be22aa29e3318e88", "sha256": "69bacc35c0ab4caaa31172863866cef9054fd6ac4be5bf3787cf9c46b5f0f1eb" }, "downloads": -1, "filename": "sphinx-hwt-1.2.tar.gz", "has_sig": false, "md5_digest": "4b649ceca9848639be22aa29e3318e88", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 760200, "upload_time": "2018-09-22T20:57:10", "url": "https://files.pythonhosted.org/packages/1d/66/233d20e849b6ed27ea35c5fd58a5bc14a2706b4734f0604ec63c098be25c/sphinx-hwt-1.2.tar.gz" } ], "1.3": [ { "comment_text": "", "digests": { "md5": "eff5289ef81a942bc8e7e49214a70f33", "sha256": "f407a43c01c59befc265f8620aed11dec4a7f858bf5e4b1822283af3b2d27a39" }, "downloads": -1, "filename": "sphinx-hwt-1.3.tar.gz", "has_sig": false, "md5_digest": "eff5289ef81a942bc8e7e49214a70f33", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 760214, "upload_time": "2018-09-23T09:46:19", "url": "https://files.pythonhosted.org/packages/eb/31/b6ade363ae8730529f1cd1a8ba8884bf902d0dd047be584f2fc039812378/sphinx-hwt-1.3.tar.gz" } ], "1.4": [ { "comment_text": "", "digests": { "md5": "9f8c00371138f54cea443ce32f345906", "sha256": "eb246ccced13a4597048160fb3fbdcf5dd73658353b6fa6ab8d4eebbfbdd8550" }, "downloads": -1, "filename": "sphinx-hwt-1.4.tar.gz", "has_sig": false, "md5_digest": "9f8c00371138f54cea443ce32f345906", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 760296, "upload_time": "2018-09-23T13:45:59", "url": "https://files.pythonhosted.org/packages/65/d4/577583299327f293ea0c31987f1b9ee98bced89c89b8009703439bcbcd8c/sphinx-hwt-1.4.tar.gz" } ], "1.5": [ { "comment_text": "", "digests": { "md5": "1d211db9ee8201710614fa65e54084a9", "sha256": "db2746230d8aab40c3204d6d5dbfba553a649edeaf14e8dc48ccd54e2190e0ac" }, "downloads": -1, "filename": "sphinx-hwt-1.5.tar.gz", "has_sig": false, "md5_digest": "1d211db9ee8201710614fa65e54084a9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 760366, "upload_time": "2018-09-23T14:03:46", "url": "https://files.pythonhosted.org/packages/65/ef/7f85240c8052931e5c60d154f178b6b9aab3abfaaa8f63eb801f08cd9f58/sphinx-hwt-1.5.tar.gz" } ], "1.6": [ { "comment_text": "", "digests": { "md5": "4f0f91e61717bf6a6217e5b864d81817", "sha256": "860808a0d49b180021bf84a75928b6a5c59ed28eddcb49f0d793e168e41d2674" }, "downloads": -1, "filename": "sphinx-hwt-1.6.tar.gz", "has_sig": false, "md5_digest": "4f0f91e61717bf6a6217e5b864d81817", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 760596, "upload_time": "2018-09-23T16:44:53", "url": "https://files.pythonhosted.org/packages/d5/10/345ab86a1a4053ce323edf4522f9a2d695e69f5a834af16542fd29d3e73a/sphinx-hwt-1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4f0f91e61717bf6a6217e5b864d81817", "sha256": "860808a0d49b180021bf84a75928b6a5c59ed28eddcb49f0d793e168e41d2674" }, "downloads": -1, "filename": "sphinx-hwt-1.6.tar.gz", "has_sig": false, "md5_digest": "4f0f91e61717bf6a6217e5b864d81817", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 760596, "upload_time": "2018-09-23T16:44:53", "url": "https://files.pythonhosted.org/packages/d5/10/345ab86a1a4053ce323edf4522f9a2d695e69f5a834af16542fd29d3e73a/sphinx-hwt-1.6.tar.gz" } ] }