From 45533c6700bc22bb2e2a2b97bd0f6a51036144e9 Mon Sep 17 00:00:00 2001 From: James Zhu Date: Sun, 12 May 2019 14:32:57 -0700 Subject: [PATCH] Add doc generation to README --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5f9e0b9f..f0b18f17 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ and managed with Vagrant (dependencies, database setup, etc). Your copy of hkn-rails on your host is a shared directory with `\vagrant` on your guest, so you can edit files in either machine. -The guest is configured to port forward 3000 on the vm to 3000 on the host. +The guest is configured to port forward 3000 on the vm to 3000 on the host. When creating virtual machine, the provisioning script in `Vagrantfile` will: @@ -139,7 +139,7 @@ rake db:reset && rake db:backup:restore FROM=[path] ## Static Files -To serve new static files in production, first run +To serve new static files in production, first run ```sh RAILS_ENV=production bundle exec rake assets:precompile @@ -175,6 +175,16 @@ already done in production): For examples of searching, see [coursesurveys#search][coursesurveys] and [course.rb][course.rb]. +## Documentation + +To generate the API documentation, run: + +```sh +bundle exec yard +``` + +This will generate documentation from source comments at `doc/`. + [searchables]: http://github.com/outoftime/sunspot/wiki/Setting-up-classes-for-search-and-indexing [coursesurveys]: app/controllers/coursesurveys_controller.rb#L448 [course.rb]: app/models/course.rb#L45