#88 Suggestion: Online reStructuredText Viewer

pending
nobody
None
2020-03-06
2020-02-27
Anonymous
No

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

Discussion

  • Ingo

    Ingo - 2020-02-28

    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.

     
    👍
    1
  • Ingo

    Ingo - 2020-02-28
    • labels: SUGGESTION: reStructuredText Viewer, Suggestion: Online reStructuredText Viewer -->
    • status: open --> pending
     
  • aliazzz

    aliazzz - 2020-03-06

    Nice!
    Though, I seem to have asked for this too :

    *.rst markup language support for Allura? *

     
  • Ingo

    Ingo - 2020-03-06

    Impossible, sorry ;)
    This would be a too deep change in Allura.

     
  • aliazzz

    aliazzz - 2020-03-06

    I ment cForge platform, but semantics got in the way I guess.....

     

Log in to post a comment.