Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make a studoc command #19

Open
mikey-austin opened this issue Sep 4, 2018 · 0 comments
Open

Make a studoc command #19

mikey-austin opened this issue Sep 4, 2018 · 0 comments

Comments

@mikey-austin
Copy link
Owner

mikey-austin commented Sep 4, 2018

Now that we have modules, let's document them! This task is to make a studoc program to parse module files and extract the following information:

  • Module name
  • Module doc string
  • All defun'd functions, their doc strings and their argument formals
  • All defmacro'd macros + their doc strings
  • All def'd things

Once the above information is extracted, we can output the info in various formats:

  • POD formatted documentation, so we can generate HTML & man pages for each module
  • S-expressions so it can be processed by other programs easily
  • Maybe other specific options to just output specific bits

For example:

$ studoc --module mymod.stu --output pod    # To output POD documentation to stdout
$ studoc --module mymod.stu --output sexp   # To output S-expressions
$ studoc --module mymod.stu --modname       # Specificly dump the module name
my-mod-name
$ studoc --module mymod.stu --functions
my-func-1
my-func-2
$ studoc --module mymod.stu --functions --docstrings
my-func-1 - First function documention
my-func-2 - See above function

Perhaps the --module option could search the interpreter include path, in which case the resolution logic needs to be slightly refactored/moved around.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant