{ "info": { "author": "Lucas Bourneuf", "author_email": "lucas.bourneuf@laposte.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# TextX DSL autodocumentation tool\nA non-official TextX poc-project aiming to autogenerate documentation of DSL.\n\nFor testing the TextX integration, you will be required to install [from repository](https://github.com/textX/textX) since the CLI extending is not available in 1.8.\n\n\n## Files\n\n- [example.py](example.py): example of DSL definition directly taken [from another project](https://github.com/aluriak/24h2019)\n- [out.html](out.html): the HTML output file (take a look to get a feeling of the current project achievements)\n- [poc.py](poc.py): first implementation, absolutely bad, but few functions are worth saving\n- [poc_as_cls.py](poc_as_cls.py): use some functions of `poc.py` to implement the same thing, but in a clearer manner\n- [poc_render_peg.py](poc_render_peg.py): rendering of arpeggio (textx backend) grammars\n\n[Current results](out.html) are encouraging.\n\n## F(unny )eatures\n\n- support of docstrings (those at user classes level)\n- auto-generation of examples for regexes, and complete linking to [pythex.org](https://pythex.org)\n\n\n## TODO\n\n- integrate complete example (either randomly or author-provided)\n- get a complete example with advanced features like references and other textx/arpeggio constructs\n- fix detection and handling of terminal for the description of rules\n- generate few examples for each documented rule (randomly, probably)\n- make the generation deterministic\n- humanize the phrasing (ex: when choice only on raw strings, avoid the bullet list and list them inline directly with an *or* for the last join: *Type either _a_, _b_ or _c_*)\n- integration into textx with [textx subcommands](https://github.com/textX/textX/pull/162) (see [doc](http://textx.github.io/textX/latest/textx_command/#extending-textx-command))", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/aluriak/textx-dsldoc", "keywords": "textx subcommand,doc generation", "license": "GPL", "maintainer": "", "maintainer_email": "", "name": "textx-dsldoc", "package_url": "https://pypi.org/project/textx-dsldoc/", "platform": "", "project_url": "https://pypi.org/project/textx-dsldoc/", "project_urls": { "Homepage": "https://github.com/aluriak/textx-dsldoc" }, "release_url": "https://pypi.org/project/textx-dsldoc/0.0.1/", "requires_dist": null, "requires_python": "", "summary": "Autogeneration of DSL documentation for TextX", "version": "0.0.1" }, "last_serial": 4825583, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "5915051cdc525798ce752d9369f0df97", "sha256": "e1cc948e466ec21910925e0ee61ca932921bae5ce604137e3533e266a4738f45" }, "downloads": -1, "filename": "textx_dsldoc-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "5915051cdc525798ce752d9369f0df97", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12833, "upload_time": "2019-02-15T15:36:43", "url": "https://files.pythonhosted.org/packages/d0/36/a104f8ef622f79acb389287a19dd53f30065a466c8a4472654f0ffd89f4c/textx_dsldoc-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "72cefbb96bfe848ed141021b08718b7f", "sha256": "c5df0211a20741f62de8073fb6e66aade2e569eb6444494f75367d0938b11e45" }, "downloads": -1, "filename": "textx-dsldoc-0.0.1.tar.gz", "has_sig": false, "md5_digest": "72cefbb96bfe848ed141021b08718b7f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10341, "upload_time": "2019-02-15T15:36:41", "url": "https://files.pythonhosted.org/packages/15/0c/d77010e23f371134d88072332b1b88fe9ffc9c7cb7fa81c14d482ec34ff7/textx-dsldoc-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5915051cdc525798ce752d9369f0df97", "sha256": "e1cc948e466ec21910925e0ee61ca932921bae5ce604137e3533e266a4738f45" }, "downloads": -1, "filename": "textx_dsldoc-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "5915051cdc525798ce752d9369f0df97", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12833, "upload_time": "2019-02-15T15:36:43", "url": "https://files.pythonhosted.org/packages/d0/36/a104f8ef622f79acb389287a19dd53f30065a466c8a4472654f0ffd89f4c/textx_dsldoc-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "72cefbb96bfe848ed141021b08718b7f", "sha256": "c5df0211a20741f62de8073fb6e66aade2e569eb6444494f75367d0938b11e45" }, "downloads": -1, "filename": "textx-dsldoc-0.0.1.tar.gz", "has_sig": false, "md5_digest": "72cefbb96bfe848ed141021b08718b7f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10341, "upload_time": "2019-02-15T15:36:41", "url": "https://files.pythonhosted.org/packages/15/0c/d77010e23f371134d88072332b1b88fe9ffc9c7cb7fa81c14d482ec34ff7/textx-dsldoc-0.0.1.tar.gz" } ] }