Wraps the functionality of https://rubygems.org/gems/sdoc inside a Docker image
Bind a local volume containing one or more Ruby and/or Rails source trees:
docker run --rm -i -v $(pwd)/src:/tmp/build healthcareblocks/sdoc
Note: /tmp/build is a path inside the container.
For example, your src directory might have the following structure:
src rails-4.2.5 ruby-2.3.0
After the process is complete, you'll find a new directory, sdoc, inside your local directory.
If docs were generated for more than one source tree, the merged documentation will be stored under sdoc/merged.
Any option supported by the sdoc gem can be passed to running container:
docker run --rm -i -v $(pwd)/src:/tmp/build healthcareblocks/sdoc -t 'My Docs Title' -N
Files to be ignored by the sdoc parser are defined below. To append to the list during runtime, set the -x flag:
docker run --rm -i -v $(pwd)/src:/tmp/build healthcareblocks/sdoc -x 'secret.rb coverage'