This repository has been archived by the owner on Jan 2, 2018. It is now read-only.
Move documentation generation into WeaselDiesel #30
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.
It's currently in https://github.com/mattetti/wd-sinatra, but it makes more sense in WD itself. This isn't ready to be merged, it's mostly a quick and dirty proof of concept. We should probably discuss whether or not this is the right approach.
In wd_sinatra, it was defined as a rake task. Here I changed it into a weasel_diesel CLI via Thor. It takes 1 required argument, which is the source path, and a second optional argument, which is doc destination path. I had to stub in an implementation method in WeaselDiesel, so that the doc generator could parse the web service definitions.
If you wanted it to read your ruby api files in the
api
directory, and put the doc in thedoc
directory, you would use it like:I ran it against my local test wd_sinatra app, and it seems to work.