`docstrings` equivalent about chrysalisp HOT 8 CLOSED

If I can get some REF.md file auto created containing the current functions info, I'll add support for a description.

Probably a (make-doc) command. Anyways, job for tomorrow :)

from chrysalisp.

Run the text ui. Via './run_tui.sh' then at the terminal prompt, type 'lisp.lisp' to run the Lisp interpreter. Then you can run (make-doc) to generate the doc/CLASSES.md file from the sources.

cntrl-c to exit the Lisp terminal.

The (make-doc) function is in the 'cmd/asm.inc' file at the bottom if you feel like having a play with the code. It's reasonably easy to follow.

Regards

Chris

from chrysalisp.

Not exactly 'docstrings' but the result is good. Thanks for the prompt to get this done Alex.

Chris

from chrysalisp.

I was just talking to Andy about auto generating the ref documentation. The current make command is half way to being able to do that and I was going to look at getting a similar peice of code to output .md files for each function tomorrow.

Also, yes, there needs to be a section added like the 'inputs' and 'outputs' like 'description' that can be pulled out and added to those ref docs beyond the registers usage info.

Chris

from chrysalisp.

Awesome, feel free to let me know if you need any changes to the sphinx side of things.

from chrysalisp.

First attempt at an (make-doc) command pushed :)
Needs work, but gets us started.

from chrysalisp.

I'm not sure how to run that from the linux environment.

from chrysalisp.

Just pushed a version of (make-doc) that uses de-structuring to make things clearer.

from chrysalisp.