Add doc generator #283
Merged
Add doc generator #283
Conversation
This file contains 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
added 23 commits
February 26, 2015 10:13
…d-doc-generator
…d-doc-generator
| @@ -0,0 +1,9 @@ | |||
| YUI.add("yuidoc-meta", function(Y) { | |||
| } | ||
| }, focusManager, '_focusPrevious', focusManager); | ||
|
|
||
| Y.before(function (e, activeDescendant) { |
There was a problem hiding this comment.
'activeDescendant' is defined but never used.
| gulp.watch('css/*.scss', ['sass']); | ||
| }); | ||
|
|
||
| gulp.task("docs-rename", function() { |
| change: noop, | ||
|
|
||
| // Called every time the DK element is opened | ||
| /** | ||
| * Called whenever the Dropkick select is opened. The value of `this` is the Dropkick object itself. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
WHAT IS THIS!?
This adds doc generation from
dropkick.js. Right from the source. This makes reading the source easier and maintaining the docs so much easier. I went with YUIDoc to generate the docs since that's the generator that allows theming. I needed to shape and mold the theme to what I needed since DropKick is pretty small.There are some fairly complex (read: probably bad) gulp tasks that take care of this for us.
First the yuidoc command is run via NPM. I use a gulp package that can run npm scripts and use that to build the docs, then copy the classes file, rename to index, and then put it in the root of the docs folder. Why? Because with yuidoc you can put the classes content into the index file due to the way the data flows. So we have this (hacky) way of getting what we want. Does it work? For sure! Is it pretty? Hell no!
What's after this?
More doc theme improvements, improving the actual docs wording, and finishing the release process (#270).