{ "info": { "author": "ponty", "author_email": "UNKNOWN", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: POSIX :: Linux", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "This Sphinx_ 1.0 extension executes GTKWave_ during the build step and\nincludes its screenshot into the documentation.\nGTKWave_ can display wave files like VCD_ (value change dump).\n\nLinks:\n * home: https://github.com/ponty/sphinxcontrib-gtkwave\n * documentation: http://ponty.github.com/sphinxcontrib-gtkwave\n\nFeatures\n-------------\n - development on linux\n \nKnown problems\n------------------\n - Python 3 is not supported\n - PDF output is not perfect\n - no unittests\n\nBasic usage\n------------------\n::\n\n .. gtkwave:: docs/gtkwave_output.vcd\n \nHow it works\n------------------\n\nThis is a workaround, there is no image export in GTKWave_\n\n#. start Xvfb headless X server using pyvirtualdisplay_\n#. redirect GTKWave_ display to Xvfb server by setting $DISPLAY variable.\n#. start GTKWave_ with VCD file. Options are set on command-line and in temporary rc file\n#. temporary tcl script will set time interval and select all signals \n#. wait until GTKWave_ is displayed\n#. take screenshot by pyscreenshot_ which needs scrot.\n#. image is processed: toolbar, scrollbar and empty space are removed\n#. use ``.. image::`` directive to display image\n \n\nInstallation\n------------------\n\nGeneral\n^^^^^^^^^^^\n\n * install GTKWave_\n * install Xvfb_ and Xephyr_\n * install PIL_\n * install scrot\n * install pip_\n * install the program::\n\n # as root\n pip install sphinxcontrib-gtkwave\n\n\nUbuntu\n^^^^^^^^^^^\n::\n\n sudo apt-get install gtkwave\n sudo apt-get install python-pip\n sudo apt-get install scrot\n sudo apt-get install xvfb\n sudo apt-get install xserver-xephyr\n sudo apt-get install python-imaging\n sudo pip install sphinxcontrib-gtkwave\n\n\nUninstall\n^^^^^^^^^^^\n::\n\n # as root\n pip uninstall sphinxcontrib-gtkwave\n\n\n.. _Sphinx: http://sphinx.pocoo.org/latest\n.. _`sphinx-contrib`: http://bitbucket.org/birkenfeld/sphinx-contrib\n.. _setuptools: http://peak.telecommunity.com/DevCenter/EasyInstall\n.. _pip: http://pip.openplans.org/\n.. _Xvfb: http://en.wikipedia.org/wiki/Xvfb\n.. _Xephyr: http://en.wikipedia.org/wiki/Xephyr\n.. _PIL: http://www.pythonware.com/library/pil/\n.. _pyscreenshot: https://github.com/ponty/pyscreenshot\n.. _pyvirtualdisplay: https://github.com/ponty/PyVirtualDisplay\n.. _gtkwave: http://gtkwave.sourceforge.net/\n.. _vcd: http://en.wikipedia.org/wiki/Value_change_dump", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ponty/sphinxcontrib-gtkwave", "keywords": "sphinx screenshot gtkwave vcd", "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "sphinxcontrib-gtkwave", "package_url": "https://pypi.org/project/sphinxcontrib-gtkwave/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/sphinxcontrib-gtkwave/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/ponty/sphinxcontrib-gtkwave" }, "release_url": "https://pypi.org/project/sphinxcontrib-gtkwave/0.0.6/", "requires_dist": null, "requires_python": null, "summary": "Sphinx extension to include screenshot of GTKWave", "version": "0.0.6" }, "last_serial": 962722, "releases": { "0.0.6": [ { "comment_text": "", "digests": { "md5": "ff0c2f13379e17324e15da617565790c", "sha256": "69b3a47c8c6d0fa2e30c1beed04531057b8c1a9954c86ce30f0e259c20149d8c" }, "downloads": -1, "filename": "sphinxcontrib-gtkwave-0.0.6.tar.gz", "has_sig": false, "md5_digest": "ff0c2f13379e17324e15da617565790c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8498, "upload_time": "2014-01-07T13:04:06", "url": "https://files.pythonhosted.org/packages/36/66/6d115492987194c214badddfe296f5161dad66af91facc78212f1563ecd6/sphinxcontrib-gtkwave-0.0.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ff0c2f13379e17324e15da617565790c", "sha256": "69b3a47c8c6d0fa2e30c1beed04531057b8c1a9954c86ce30f0e259c20149d8c" }, "downloads": -1, "filename": "sphinxcontrib-gtkwave-0.0.6.tar.gz", "has_sig": false, "md5_digest": "ff0c2f13379e17324e15da617565790c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8498, "upload_time": "2014-01-07T13:04:06", "url": "https://files.pythonhosted.org/packages/36/66/6d115492987194c214badddfe296f5161dad66af91facc78212f1563ecd6/sphinxcontrib-gtkwave-0.0.6.tar.gz" } ] }