Simpler documentation#2984
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
mrb_obj_mrb_define_class_underrespond_to seems to be a typo ?
Contributor
Author
|
@furunkel Thanks for the headsup! fixed |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi,
Keeping up with my documentation efforts (#2959) I worked on a better/simpler approach to documenting mruby.
Here I left everything ready to be documented using a YARD plugin tailored for mruby projects (yard-mruby).
To generate the docs all it's needed is the
yard-mrubygem and executing themrbdoccommand (which applies to generating mrbgem docs too).Here the docs get generated at
doc/apiand already merged all the docs already atdoc/apiinto their respective header. and moved all other files in doc intodoc/guidesYou can take a look at the generated docs at http://sagmor.com/mruby to get an idea of the end result and soon will be pushing a PR for mruby.org website