I have been preparing documentation using reStructuredText as described in the help file. There is an online viewer at the link below that is extremely helpful. I can paste portions of my document into the viewer to see if it renders correctly. However, the problem is that the codesys extensions are not supported there, especially ".. code-block:: codesys" ;)
Online Viewer: http://rst.ninjs.org/
Python Script: https://mg.pov.lt/restview/
Both of the above links are open source on Github. I believe the online viewer uses the same pythopn script. I was wondering if the codesys extensions could be added to the above online viewer or if codesys would be willing to host such a viewer, with codesys extensions, here on the forge?
One other related comment/suggestion I have is to give some thought to adding the ability to similarly document entire projects. It would be nice to automatically generate a document containing program abstracts/descriptions, api for user created function blocks and data types, and possibly global/program variable definitions. The result could be a hyper-linked document accessible from a visualization or the help file. Just a side thought rather than an immediate need.
Thanks for listening
RickJ
Good idea. Some googeling brought me to this one:
https://seikichi.github.io/restructured/
Pure Javascript, and seems to be MIT. Maybe we can simply host a version, support those special tags in a small project. Needs more investigation.
Nice!
Though, I seem to have asked for this too :
*.rst markup language support for Allura? *
Impossible, sorry ;)
This would be a too deep change in Allura.
I ment cForge platform, but semantics got in the way I guess.....
Please integrate this also!ππͺπ