Skip to content

Commit

Permalink
Add doc generation to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jameslzhu committed May 12, 2019
1 parent de2f852 commit 45533c6
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

0 comments on commit 45533c6

Please sign in to comment.