{ "info": { "author": "Alex Mykyta", "author_email": "amykyta3@github.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python", "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 :: Software Development :: Documentation" ], "description": "[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ralbot-html.svg)](https://pypi.org/project/ralbot-html)\n\n# RALBot-html\nGenerate address space documentation HTML from compiled SystemRDL input\n\n## Installing\nInstall from [PyPi](https://pypi.org/project/ralbot-html) using pip:\n\n python3 -m pip install ralbot-html\n\n\n## Example\nAn example of HTML output generated from a\n[fictional SystemRDL register description](example/turboencabulator.rdl).\n\n[https://systemrdl.github.io/RALBot-html](https://systemrdl.github.io/RALBot-html)\n\n\n## Usage\nPass the elaborated output of the [SystemRDL Compiler](http://systemrdl-compiler.readthedocs.io)\ninto the exporter.\n\nAssuming `root` is the elaborated top-level node, or an internal `AddrmapNode`:\n\n```python\nfrom ralbot.html import HTMLExporter\n\nexporter = HTMLExporter()\n\nexporter.export(root, \"path/to/output\")\n```\n\n\n## Reference\n\n### `HTMLExporter(**kwargs)`\nConstructor for the HTML exporter class\n\n**Optional Parameters**\n\n* `markdown_inst`\n * Override the class instance of the Markdown processor.\n See the [Markdown module](https://python-markdown.github.io/reference/#Markdown)\n for more details.\n* `user_template_dir`\n * Path to a directory where user-defined template overrides are stored.\n* `user_static_dir`\n * Path to user-defined static content to copy to output directory.\n* `user_context`\n * Additional context variables to load into the template namespace.\n* `show_signals`\n * Show signal components. Default is False\n\n### `HTMLExporter.export(node, output_dir, **kwargs)`\nPerform the export!\n\n**Parameters**\n\n* `nodes`\n * Top-level node to export. Can be the top-level `RootNode` or any internal `AddrmapNode`.\n Can also be a list of `RootNode` and any internal `AddrmapNode`.\n* `output_dir`\n * HTML output directory.\n \n**Optional Parameters**\n\n* `footer`\n * Override footer text.\n* `title`\n * Override title text.\n* `home_url`\n * If a URL is specified, adds a home button to return to a parent home page.", "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/SystemRDL/RALBot-html", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "ralbot-html", "package_url": "https://pypi.org/project/ralbot-html/", "platform": "", "project_url": "https://pypi.org/project/ralbot-html/", "project_urls": { "Homepage": "https://github.com/SystemRDL/RALBot-html", "Source": "https://github.com/SystemRDL/RALBot-html", "Tracker": "https://github.com/SystemRDL/RALBot-html/issues" }, "release_url": "https://pypi.org/project/ralbot-html/1.5.0/", "requires_dist": null, "requires_python": "", "summary": "HTML documentation generator for SystemRDL-based register models", "version": "1.5.0" }, "last_serial": 5936776, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "85e1bf1263da106e30132fe7d5d97f6c", "sha256": "ac0180de43ae730f20c0eac683227c7541884ef154aa5f4855753959e6d6ff2f" }, "downloads": -1, "filename": "ralbot-html-1.0.0.tar.gz", "has_sig": false, "md5_digest": "85e1bf1263da106e30132fe7d5d97f6c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5535922, "upload_time": "2018-11-07T06:33:13", "url": "https://files.pythonhosted.org/packages/f7/5b/9e1d34a77b9d27917b8dd040d057bf0398ee15043b5fc2b21d0e132f05b2/ralbot-html-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "e90afe4a671c5805bf656abe9e60e0f9", "sha256": "fe3914091e902e87938c9c483e3a84649265ac09ec9d41f5fc746c0c439f878f" }, "downloads": -1, "filename": "ralbot-html-1.1.0.tar.gz", "has_sig": false, "md5_digest": "e90afe4a671c5805bf656abe9e60e0f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5537074, "upload_time": "2018-12-05T06:50:07", "url": "https://files.pythonhosted.org/packages/07/8a/a1c801cb7ea9478f375816388c111a7a768fa1a4b114fc40f5d63db9b0ef/ralbot-html-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "9073ac3ac9b49126826b90a293a8b930", "sha256": "519083ca4345af9d3dc1bbd97adf168957e7dab76e3b2f997e581648b940b4b9" }, "downloads": -1, "filename": "ralbot-html-1.2.0.tar.gz", "has_sig": false, "md5_digest": "9073ac3ac9b49126826b90a293a8b930", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5543591, "upload_time": "2019-02-05T04:18:34", "url": "https://files.pythonhosted.org/packages/9c/bc/6670666da911018a82cb4e659a28eaefd01b280f5c80a8cfe083cae36c38/ralbot-html-1.2.0.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "53893231e54ee96d030c67d53fb50d31", "sha256": "99e7fb88cab69f90ffdc9d14cbcc889b196f1d6fd4e8d6b6d01426c3b1dccd3a" }, "downloads": -1, "filename": "ralbot-html-1.3.0.tar.gz", "has_sig": false, "md5_digest": "53893231e54ee96d030c67d53fb50d31", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5544324, "upload_time": "2019-05-10T05:02:59", "url": "https://files.pythonhosted.org/packages/02/18/a407dcda9155699925e177e86c2e41655905f68cb22d8faca678ae4f2016/ralbot-html-1.3.0.tar.gz" } ], "1.3.1": [ { "comment_text": "", "digests": { "md5": "980481ccd391cc340edd220339aafabe", "sha256": "e6c97c610484c3cdec54144ed43a6c93ad14675a82aa58bcb73b114c5fb85107" }, "downloads": -1, "filename": "ralbot-html-1.3.1.tar.gz", "has_sig": false, "md5_digest": "980481ccd391cc340edd220339aafabe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5544349, "upload_time": "2019-06-14T06:18:14", "url": "https://files.pythonhosted.org/packages/f7/ed/0a4e9dfa0a7c371162c6679705e76f182fc0312b6db01ba99aeb9f1c7849/ralbot-html-1.3.1.tar.gz" } ], "1.3.2": [ { "comment_text": "", "digests": { "md5": "6e5858829466907dfbc47939ddcc2e10", "sha256": "9fc756e4ae35f107ca764bcafc7e8506fe99bb3612dce6dd5c7f0b9f04cdd515" }, "downloads": -1, "filename": "ralbot-html-1.3.2.tar.gz", "has_sig": false, "md5_digest": "6e5858829466907dfbc47939ddcc2e10", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5544328, "upload_time": "2019-06-23T13:49:17", "url": "https://files.pythonhosted.org/packages/62/8c/480909bb773902126926b5ffa76421945b96f41b2bbe519b369a913a1289/ralbot-html-1.3.2.tar.gz" } ], "1.4.0": [ { "comment_text": "", "digests": { "md5": "92e6db5ef0debffaa4d1a515a6fab5f3", "sha256": "77df61c9d71916b662ff7a4ee6d85f8f55c62af6f719cacae57858e08e1d8027" }, "downloads": -1, "filename": "ralbot-html-1.4.0.tar.gz", "has_sig": false, "md5_digest": "92e6db5ef0debffaa4d1a515a6fab5f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5545261, "upload_time": "2019-09-02T23:28:30", "url": "https://files.pythonhosted.org/packages/05/90/b6400b01219014e778a5733fa177b0773b692c217399b8904af225b9799e/ralbot-html-1.4.0.tar.gz" } ], "1.5.0": [ { "comment_text": "", "digests": { "md5": "ad8ef8c8eacbc72df0bc3c1007af1e6b", "sha256": "5043de12259ba4366eaa1c333eb379b41d0fd4ed6e4d398624910b7e112324ab" }, "downloads": -1, "filename": "ralbot-html-1.5.0.tar.gz", "has_sig": false, "md5_digest": "ad8ef8c8eacbc72df0bc3c1007af1e6b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5546793, "upload_time": "2019-10-07T03:38:39", "url": "https://files.pythonhosted.org/packages/02/41/3f563b39b58940cb857d46ce81d86ad9ad72d14593a1f22c48db6849feca/ralbot-html-1.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ad8ef8c8eacbc72df0bc3c1007af1e6b", "sha256": "5043de12259ba4366eaa1c333eb379b41d0fd4ed6e4d398624910b7e112324ab" }, "downloads": -1, "filename": "ralbot-html-1.5.0.tar.gz", "has_sig": false, "md5_digest": "ad8ef8c8eacbc72df0bc3c1007af1e6b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5546793, "upload_time": "2019-10-07T03:38:39", "url": "https://files.pythonhosted.org/packages/02/41/3f563b39b58940cb857d46ce81d86ad9ad72d14593a1f22c48db6849feca/ralbot-html-1.5.0.tar.gz" } ] }