Function Documentation Specification
FrankC01 opened this issue · 3 comments
My first thought is about reliance on any third party system.
If the goal is to produce good reference docs from source comments and code then I still believe that should be done by a Lisp command line app.
The current one is crude and needs more refinement but can be enhanced with not much effort. Once we agree on a common inline format we can add the enhancements.
I'm quite happy with the .md format for online documents that are not auto generated too. It's a simple format that most platforms have good readers for. Plus we already do a passable but needs improvements Docs app for viewing them in the GUI.
Early on Alex did some work on Sphinx based scripts. But over time the dependencies changed and Python libs needed updates and so things stopped being actively updated! And this is the source of my worry if we introduce an outside app, who is going to maintain it and make sure it is available on all platforms?
At least if we use our own Lisp command line app then it will be available on every platform ChrysaLisp runs on.
I noted them for reference/inspiration and agree the interp/emit to MD or whatever is native (ChrysaLisp) library
Commit now to no external third party doc apps.