From 0911b3f7b11631021beecc633d9da3276ec870c4 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Tue, 3 Sep 2019 19:20:05 -0400 Subject: [PATCH 1/2] Clear contents of docs/ before regenerating --- Rakefile | 1 + 1 file changed, 1 insertion(+) diff --git a/Rakefile b/Rakefile index b58d69835..8e3104b2e 100644 --- a/Rakefile +++ b/Rakefile @@ -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 From 5fd6a501a1d7d28a4421970b0bb33827efe0cac2 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Tue, 3 Sep 2019 19:42:38 -0400 Subject: [PATCH 2/2] README: fix suggested `jekyll serve` command & Action link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f98aa709..61d39020c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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