diff --git a/.gitignore b/.gitignore index 1e334399..0932df8a 100644 --- a/.gitignore +++ b/.gitignore @@ -13,9 +13,11 @@ public/**/*_cached.* .get-dump.yml .sass-cache/ doc/app/ +doc/api/ +.yarddoc/ # Deployment tools Capfile config/deploy.rb config/deploy/* .localeapp -.bundle \ No newline at end of file +.bundle diff --git a/.yardopts b/.yardopts new file mode 100644 index 00000000..3380ff49 --- /dev/null +++ b/.yardopts @@ -0,0 +1 @@ +-o doc/api --plugin yard-activerecord --no-private --protected app/**/*.rb db/schema.rb - *.md doc/**/*.md LICENSE diff --git a/Gemfile b/Gemfile index 431adecf..739a1e18 100644 --- a/Gemfile +++ b/Gemfile @@ -78,6 +78,8 @@ end group :development, :test do gem 'ruby-prof', require: false + gem 'yard-activerecord', require: false + #gem 'yard-rails-plugin', github: 'ogeidix/yard-rails-plugin', tag: 'v0.0.1', require: false end group :test do diff --git a/Gemfile.lock b/Gemfile.lock index 6beeafda..c383c396 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -386,6 +386,9 @@ GEM rinku xpath (2.0.0) nokogiri (~> 1.3) + yard (0.8.7.4) + yard-activerecord (0.0.11) + yard (>= 0.8.3) PLATFORMS ruby @@ -453,3 +456,4 @@ DEPENDENCIES twitter-bootstrap-rails uglifier (>= 1.0.3) whenever + yard-activerecord diff --git a/README.md b/README.md index e19bfcdd..d421dffe 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ Foodsoft [![Coverage Status](https://coveralls.io/repos/foodcoops/foodsoft/badge.png?branch=master)](https://coveralls.io/r/foodcoops/foodsoft?branch=master) [![Code Climate](https://codeclimate.com/github/foodcoops/foodsoft.png)](https://codeclimate.com/github/foodcoops/foodsoft) [![Dependency Status](https://gemnasium.com/foodcoops/foodsoft.png)](https://gemnasium.com/foodcoops/foodsoft) +[![yard docs](http://b.repl.ca/v1/yard-docs-blue.png)](http://rubydoc.info/github/foodcoops/foodsoft/frames) Web-based software to manage a non-profit food coop (product catalog, ordering, accounting, job scheduling).