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

Generate a framework for the documentation efforts from the existing info strings. #48

Open
Tracked by #43
andrewbwm opened this issue Aug 3, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@andrewbwm
Copy link
Collaborator

andrewbwm commented Aug 3, 2021

While investigating the possibility of generating documentation from the info strings I found reStructuredText and Sphinx which seem like relatively mature tools.

However, maybe this is something we would like to implement in the great malcompiler rewrite rather than specifically for coreLang.

@andrewbwm andrewbwm self-assigned this Aug 3, 2021
@andrewbwm andrewbwm added the documentation Improvements or additions to documentation label Aug 11, 2021
@andrewbwm andrewbwm added this to the v1.0.0 Release milestone Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant