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

Automatically generate documentation from existing metadata #7

Closed
andrewbwm opened this issue Aug 11, 2021 · 1 comment
Closed

Automatically generate documentation from existing metadata #7

andrewbwm opened this issue Aug 11, 2021 · 1 comment

Comments

@andrewbwm
Copy link

This issue stems from a conversation regarding the documentation efforts in coreLang, which can be found here.

The general idea would be to have the malcompiler generate the rst(reStructuredText) file that can then be augmented and plugged into Sphinx.

The reason for having it in the compiler is that it already contains a parser and can therefore more easily generate the rst files. This would also mean that the support for automatically generated documentation would be available to all MAL languages.

@maxwalls
Copy link
Collaborator

I suggest creating a separate tool for this. This compiler outputs a .mar file that contains all information about a language, including info strings. This output file can be opened with the library https://github.com/mal-lang/mal-langspec for programmatic access to all information, and it can be opened manually since it is a ZIP archive that contains a JSON file describing every aspect of a language. This makes it easier to create separate tools that integrate with a MAL language, and I think generating documentation would best be done this way.

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

2 participants