Open klauer opened 2 years ago
GVLs and PROGRAM now work as of #19
Copying in part of my comment from #87 -
For those anxious for Sphinx support, consider sphinx-plc. I think their implementation has better sphinx integration overall that blark may borrow ideas from in the future.
Future work will be, probably roughly in this order:
1. Investigate how to better structure the domain and directives (and learn from the Python implementation, sphinx-plc, etc.) 2. Bring my doc testing repo to GitHub so that others can more easily try blark's sphinx support 3. Rework/rewrite it in a submodule, breaking up the pieces a bit more (`blark.sphinxdomain.*` perhaps)
The sphinx domain allows for generating PLC project API documentation directly from the source code. Currently, it's pretty limited - the proof-of-concept from #12 is now in master.
A simple example might be:
conf.py
and the reStructuredText source:
Where to from here? Some notes to self mostly: