{ "info": { "author": "Bavo Van Achte, Stefan Wallentowitz", "author_email": "bavo.van.achte@gmail.com, stefan@wallentowitz.de", "bugtrack_url": null, "classifiers": [], "description": "Sphinx wavedrom extension \n=========================\n\nA sphinx extension that allows including wavedrom diagrams by using its text-based representation\n\nWavedrom online editor and tutorial: http://wavedrom.com/\n\n.. image:: https://travis-ci.org/bavovanachte/sphinx-wavedrom.svg?branch=master\n\t:target: https://travis-ci.org/bavovanachte/sphinx-wavedrom\n\n.. image:: https://badge.fury.io/py/sphinxcontrib-wavedrom.svg\n\t:target: https://badge.fury.io/py/sphinxcontrib-wavedrom\n\nInstallation\n------------\n\nThe wavedrom extension can be installed using pip:\n\n::\n\n\tpip install sphinxcontrib-wavedrom\n\nand by adding **'sphinxcontrib.wavedrom'** to the extensions list in your conf.py file.\n\nDirectives\n----------\n\nThe extension is useable in the form of an extra wavedrom directive, as shown below.\n\n::\n\n\t.. wavedrom::\n\n\t\t{ \"signal\": [\n\t\t \t{ \"name\": \"clk\", \"wave\": \"P......\" },\n\t\t \t{ \"name\": \"bus\", \"wave\": \"x.==.=x\", \"data\": [\"head\", \"body\", \"tail\", \"data\"] },\n\t\t \t{ \"name\": \"wire\", \"wave\": \"0.1..0.\" }\n\t\t]}\n\nAlternatively, it can read the json from a file:\n\n::\n\n\t.. wavedrom:: mywave.json\n\nWhen configured to generate images (see `Configuration`_) the directive will generate an image and include\nit into the input. It allows for the same configuration as the image directive:\n\n::\n\n\t.. wavedrom:: mywave.json\n :height: 100px\n :width: 200 px\n :scale: 50 %\n :alt: alternate text\n :align: right\n\nThe image can be turned into a figure by adding a caption:\n\n::\n\n .. wavedrom:: mywave.json\n :caption: My wave figure\n\nThe extension can be configured (see `Configuration`_) to not generate an image out of the diagram description\nitself, but to surround it with some html and js tags in the final html document that allow the images to be rendered\nby the browser. This is the currently the default for HTML output.\n\nConfiguration\n-------------\n\nThe extension can be configured to either directly output images or by emitting the javascript to live-render the\nwavedrom code, which obviously only works for HTML output. All other outputs (most notably ``latexpdf``) embed a\ngenerated image in any case, but this is only supported when using Python 3.\n\nFor HTML output the configuration item ``wavedrom_html_jsinline`` (default: ``True``) can toggled to generate images\ninstead of inline javascript code. You must add the following line to your ``conf.py``:\n\n::\n\n wavedrom_html_jsinline = False\n\nor overwrite the setting on the command line, for example:\n\n::\n\n sphinx-build -b html -D wavedrom_html_jsinline=0 sources build/html\n\nHTML: Inline Javascript\n```````````````````````\n\nWhen HTML building is configured to inline the javascript (default), the extension can work in 2 modes:\n\n- Online mode: \tthe extension links to the javascript file(s) provided by the wavedrom server\n- Offline mode: the extension uses the javascript file(s) that are saved locally on your drive.\n\nThe online mode is the default one. This requires no configuration in conf.py\n\nIf offline mode is desired, the following parameters need to be provided:\n\n- **offline_skin_js_path** : the path to the skin javascript file (the url to the online version is \"http://wavedrom.com/skins/default.js\")\n- **offline_wavedrom_js_path** : the path to the wavedrom javascript file (the url to the online version is \"http://wavedrom.com/WaveDrom.js\")\n\nThe paths given for these configurations need to be relative to the configuration directory (the directory that contains conf.py)\n\n\nExamples\n--------\n\nIn the `example` folder, you can find a couple of examples (taken from the wavedrom tutorial), illustration the use of the extension.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bavovanachte/sphinx-wavedrom", "keywords": "sphinx,wavedrom,documentation", "license": "MIT license", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-wavedrom", "package_url": "https://pypi.org/project/sphinxcontrib-wavedrom/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-wavedrom/", "project_urls": { "Homepage": "https://github.com/bavovanachte/sphinx-wavedrom" }, "release_url": "https://pypi.org/project/sphinxcontrib-wavedrom/2.0.0/", "requires_dist": [ "Sphinx (>=1.8)", "wavedrom (>=0.1)", "cairosvg (>=2); python_version >= \"3.3\"", "xcffib; python_version >= \"3.3\"" ], "requires_python": "", "summary": "A sphinx extension that allows generating wavedrom diagrams based on their textual representation", "version": "2.0.0" }, "last_serial": 5265838, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "8702d080811e02b83e23eb78674b45a8", "sha256": "d6833d46f1cab03cc65e3b995d347965417efb562b6285bf0558110ff0caf918" }, "downloads": -1, "filename": "sphinxcontrib-wavedrom-1.0.1.zip", "has_sig": false, "md5_digest": "8702d080811e02b83e23eb78674b45a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7046, "upload_time": "2016-07-03T19:27:03", "url": "https://files.pythonhosted.org/packages/c1/a8/687b4ba4d84d6ada1cae68f22a6bde00475307d83bc635da2c4a26cfdfbd/sphinxcontrib-wavedrom-1.0.1.zip" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "4c40d24b4a3e6db19a33fe218ae1a116", "sha256": "3cf09ed97ca1101b05aad7e3ff6422e9a9df00ec3880b3a18bcb0b35c44ed65b" }, "downloads": -1, "filename": "sphinxcontrib-wavedrom-1.1.0.zip", "has_sig": false, "md5_digest": "4c40d24b4a3e6db19a33fe218ae1a116", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7592, "upload_time": "2016-07-06T15:38:57", "url": "https://files.pythonhosted.org/packages/42/a1/4d97624b39e3056304979bed8ec59508ad99714f726cdddba1001446439e/sphinxcontrib-wavedrom-1.1.0.zip" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "d048506e662ab8c7b7eeb8eff1d3cd68", "sha256": "df2efa93d1ba2ba6d95191261e10ef54b7755ea3e786b8e6ee5f1006bec5e352" }, "downloads": -1, "filename": "sphinxcontrib-wavedrom-1.2.0.tar.gz", "has_sig": false, "md5_digest": "d048506e662ab8c7b7eeb8eff1d3cd68", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3519, "upload_time": "2016-11-21T08:00:13", "url": "https://files.pythonhosted.org/packages/d8/76/f7d26cba60a3b68296fbe546e68d25fc66494e063587b1dc1271e5da5950/sphinxcontrib-wavedrom-1.2.0.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "ecf79e9e7a284aa0cfb7a9a684c0d981", "sha256": "fdaaeb119e90a6bab40f4c917cae8397f76285910b317c5de67a2f17848767a6" }, "downloads": -1, "filename": "sphinxcontrib-wavedrom-1.3.0.tar.gz", "has_sig": false, "md5_digest": "ecf79e9e7a284aa0cfb7a9a684c0d981", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3625, "upload_time": "2016-11-21T19:46:34", "url": "https://files.pythonhosted.org/packages/16/09/6144fe64656d7653f30beb9d845454a4b61fd4c10cfa56ce21d3ac9d4301/sphinxcontrib-wavedrom-1.3.0.tar.gz" } ], "1.3.1": [ { "comment_text": "", "digests": { "md5": "a65e0551bbcaf0404a4318a9945d2b2e", "sha256": "db2c15854d361521f5a518234fcdf4fd2cdaa27c9673612923e37c0b869950e0" }, "downloads": -1, "filename": "sphinxcontrib-wavedrom-1.3.1.tar.gz", "has_sig": false, "md5_digest": "a65e0551bbcaf0404a4318a9945d2b2e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3644, "upload_time": "2018-02-19T09:22:00", "url": "https://files.pythonhosted.org/packages/52/61/716daebc1b212b11e810b991bf5cf5b052b9fe0699981ab974ccb33fb60b/sphinxcontrib-wavedrom-1.3.1.tar.gz" } ], "2.0.0": [ { "comment_text": "", "digests": { "md5": "6b1fa774e270f370b342a904c5142ad2", "sha256": "de0552e18e9ca504e87cde5816012da71de283ab1e5e8218319212a14936c7c0" }, "downloads": -1, "filename": "sphinxcontrib_wavedrom-2.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6b1fa774e270f370b342a904c5142ad2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9581, "upload_time": "2018-11-30T10:57:41", "url": "https://files.pythonhosted.org/packages/5b/ee/7f8a4cf6a590fcf060ca4bde188cb5afaade80e1155e93d9a32545272127/sphinxcontrib_wavedrom-2.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "32a30fbac370932e89198908dbdcf200", "sha256": "42fcf9be20fc0591e52aa0dab1add24ae538d65751fc1f53c7fdc682f137635a" }, "downloads": -1, "filename": "sphinxcontrib-wavedrom-2.0.0.tar.gz", "has_sig": false, "md5_digest": "32a30fbac370932e89198908dbdcf200", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35336, "upload_time": "2018-11-30T10:57:42", "url": "https://files.pythonhosted.org/packages/66/60/d46a8b941ad7045dbfbbb509a8e1a161b310edde30f1ca40b703e8044539/sphinxcontrib-wavedrom-2.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6b1fa774e270f370b342a904c5142ad2", "sha256": "de0552e18e9ca504e87cde5816012da71de283ab1e5e8218319212a14936c7c0" }, "downloads": -1, "filename": "sphinxcontrib_wavedrom-2.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6b1fa774e270f370b342a904c5142ad2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9581, "upload_time": "2018-11-30T10:57:41", "url": "https://files.pythonhosted.org/packages/5b/ee/7f8a4cf6a590fcf060ca4bde188cb5afaade80e1155e93d9a32545272127/sphinxcontrib_wavedrom-2.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "32a30fbac370932e89198908dbdcf200", "sha256": "42fcf9be20fc0591e52aa0dab1add24ae538d65751fc1f53c7fdc682f137635a" }, "downloads": -1, "filename": "sphinxcontrib-wavedrom-2.0.0.tar.gz", "has_sig": false, "md5_digest": "32a30fbac370932e89198908dbdcf200", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35336, "upload_time": "2018-11-30T10:57:42", "url": "https://files.pythonhosted.org/packages/66/60/d46a8b941ad7045dbfbbb509a8e1a161b310edde30f1ca40b703e8044539/sphinxcontrib-wavedrom-2.0.0.tar.gz" } ] }