Project

doc2json

0.0
No commit activity in last 3 years
No release in over 3 years
Generate JSON based Ruby documentations with yard
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 10.1.1
~> 1.2.2
~> 1.1.2
~> 2.14.1

Runtime

~> 1.8.1
~> 0.8.7.4
 Project Readme

Overview Gem Version

Build Status Code Climate Dependency Status

doc2json generates a JSON based ruby documentation with YARD.

Installation

gem install doc2json

Afterwards you can generate a machine friendly documentation for your project.

Usage

doc2json "lib/**/.rb" "doc/json"

This will generate a json based documentation for all *.rb files inside your lib directory and outputs the files in ./doc/json

License

Licensed under the MIT License (c) Jens Nazarenus, 2014