A Twincat handler for mkdocstrings.
Project description
mkdocstrings-twincat
A Twincat handler for mkdocstrings.
Installation
pip install mkdocstrings-twincat
This handler is using pytwincatparser to parse Twincatfiles. Currently supported are:
- .plcproj
- .tcio
- .tcpou
- .tcgvl
- .tcdut
The handler can load recursivly all objects. You just have to add the .plcproj file, and it generates the documentation for all Function Blocks etc.
Demo
At the project page you can find a demo of this handler. It parses the source code of the famous TcUnit TwinCAT unit testing framework and displays it. The documentation is not optimal, but this is because the tags are not used by tcunit.
Used packages
- mkdocstrings
- mkdocstrings-python (heavily as inspiration. really great code!)
- pytwincatparser
Be aware
I am a plc programmer. I usually dont code in python. if you find bugs, flaws, mistakes or if you have an idea how to improve or make a new feature, do not hesitate to contact me!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocstrings_twincat-0.3.10.tar.gz.
File metadata
- Download URL: mkdocstrings_twincat-0.3.10.tar.gz
- Upload date:
- Size: 30.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d6b695b5bbb57abb1ffae7a85e77834356698c8e8fb24355893d14e8aa5ffa77
|
|
| MD5 |
7db374d8d511f613f75e267dbe120b2e
|
|
| BLAKE2b-256 |
a7a1eb4a6702ffda0cc12238d53827ecc5c142bed15b4333f9b94003f2e15a79
|
File details
Details for the file mkdocstrings_twincat-0.3.10-py3-none-any.whl.
File metadata
- Download URL: mkdocstrings_twincat-0.3.10-py3-none-any.whl
- Upload date:
- Size: 40.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0200c0637c7cfba195d4426d2fa51731be2f2d64885e131776c49021fcd447d0
|
|
| MD5 |
a2d174cd9494aa7d11cca980c01f0075
|
|
| BLAKE2b-256 |
1b0977601a1bb568a99e6a2490b659bf064094ac8de82c39b187d4bdd9db662e
|
