# TextX DSL autodocumentation tool A non-official TextX poc-project aiming to autogenerate documentation of DSL.
For 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.
## Files
[example.py](example.py): example of DSL definition directly taken [from another project](https://github.com/aluriak/24h2019)
[out.html](out.html): the HTML output file (take a look to get a feeling of the current project achievements)
[poc.py](poc.py): first implementation, absolutely bad, but few functions are worth saving
[poc_as_cls.py](poc_as_cls.py): use some functions of poc.py to implement the same thing, but in a clearer manner
[poc_render_peg.py](poc_render_peg.py): rendering of arpeggio (textx backend) grammars
[Current results](out.html) are encouraging.
## F(unny )eatures
support of docstrings (those at user classes level)
auto-generation of examples for regexes, and complete linking to [pythex.org](https://pythex.org)
## TODO
integrate complete example (either randomly or author-provided)
get a complete example with advanced features like references and other textx/arpeggio constructs
fix detection and handling of terminal for the description of rules
generate few examples for each documented rule (randomly, probably)
make the generation deterministic
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_)
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))
Metadata
Release files for textx-dsldoc 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| textx-dsldoc-0.0.1.tar.gz | 10.3 kB | Without provenance | Details for textx-dsldoc-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| textx_dsldoc-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for textx_dsldoc-0.0.1-py3-none-any.whl |
Total release size: 23.2 kB
Release files / textx-dsldoc-0.0.1.tar.gz
| Download URL | textx-dsldoc-0.0.1.tar.gz |
|---|---|
| Size | 10.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c5df0211a20741f62de8073fb6e66aade2e569eb6444494f75367d0938b11e45
|
|
BLAKE2b-256 checksum How to use checksums |
150cd77010e23f371134d88072332b1b88fe9ffc9c7cb7fa81c14d482ec34ff7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.3 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.6
|
Release files / textx_dsldoc-0.0.1-py3-none-any.whl
| Download URL | textx_dsldoc-0.0.1-py3-none-any.whl |
|---|---|
| Size | 12.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e1cc948e466ec21910925e0ee61ca932921bae5ce604137e3533e266a4738f45
|
|
BLAKE2b-256 checksum How to use checksums |
d036a104f8ef622f79acb389287a19dd53f30065a466c8a4472654f0ffd89f4c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.3 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.6
|
Security for textx-dsldoc 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.