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 docs #76

Merged
merged 22 commits into from
Mar 8, 2016
Merged

generate docs #76

merged 22 commits into from
Mar 8, 2016

Conversation

bmatsuo
Copy link
Owner

@bmatsuo bmatsuo commented Mar 8, 2016

Closes #4

edit: also closes #73

The module reference index is generated in the existing location, docs/lua.md. Full documentation for each module is generated under the docs/modules/ directory using the lua hierarchy (e.g. docs/modules/lark/core.md)

The docgen command is pretty janky. But the documentation looks fine. More can be added to the docgen tool over time.

bmatsuo added a commit that referenced this pull request Mar 8, 2016
@bmatsuo bmatsuo merged commit 2b90f9e into master Mar 8, 2016
@bmatsuo bmatsuo deleted the bmatsuo/generate-docs branch March 8, 2016 15:15
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

Successfully merging this pull request may close these issues.

doc.lua: support a usage annotation Autogenerated lua documentation
1 participant