Skip to content

Commit

Permalink
Merge pull request #28 from EricFromCanada/master
Browse files Browse the repository at this point in the history
Clear contents of docs/ before regenerating
  • Loading branch information
MikeMcQuaid authored Sep 4, 2019
2 parents 46b5425 + 5fd6a50 commit db259b9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[Homebrew RubyDoc](https://rubydoc.brew.sh) is an online Ruby documentation browser for [Homebrew/brew](https://github.com/Homebrew/brew).

A [GitHub Action in Homebrew/brew](https://github.com/Homebrew/brew/blob/master/.github/main.workflow) is run on each commit, which deploys the site to GitHub Pages.
A [GitHub Action in Homebrew/brew](https://github.com/Homebrew/brew/blob/master/.github/workflows/apidoc.yml) is run on each commit, which deploys the site to GitHub Pages.

## Usage

Expand All @@ -14,7 +14,7 @@ To instead run Homebrew RubyDoc locally, run:
git clone https://github.com/Homebrew/rubydoc.brew.sh
cd rubydoc.brew.sh
bundle install
bundle exec jekyll serve
bundle exec jekyll serve --source docs
```

## License
Expand Down
1 change: 1 addition & 0 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ task default: :yard

desc "Generate documentation with YARD"
task :yard do
sh "find", "docs", "-mindepth", "1", "!", "-name", "_config.yml", "!", "-name", "CNAME", "-delete"
sh "bundle", "exec", "yard"
end

Expand Down

0 comments on commit db259b9

Please sign in to comment.