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

Generated API documentation #225

Open
MostAwesomeDude opened this issue Feb 27, 2021 · 0 comments
Open

Generated API documentation #225

MostAwesomeDude opened this issue Feb 27, 2021 · 0 comments

Comments

@MostAwesomeDude
Copy link
Contributor

We should be able to take modules and send them to API docs somehow. By case analysis on each of the modules we support:

  • Standard .mt source code is sent to API docs, as a base case
  • .mt.md literate source code is sent to Pandoc so that the literate sections can be nicely laid out, and the untangled source code is turned into API docs, and then those are concatenated
  • .asdl Zephyr ASDL type declaration is sent to ML/Haskell-ish datatype declaration plus basic API docs and how-to-ASDL blurb

On top of all of this, when we send an entire directory of modules to docs, we should generate a table of contents. We also should allow for some sort of custom documentation hook:

  • Parsers should be able to export railroad diagrams somehow
  • Interfaces should be able to export their signatures
  • Auditors should be able to declare their behaviors somewhat?
  • Controllers should be able to declare their control words
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