Skip to content

Commit c2583d8

Browse files
committed
Move docs to repository root
This eases some syncing logic in Homebrew/.github.
1 parent e817d00 commit c2583d8

File tree

5 files changed

+7
-8
lines changed

5 files changed

+7
-8
lines changed

.gitignore

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,3 @@ _site/
33
brew
44
vendor/
55
Gemfile.lock
6-
7-
# Exclude the generated site files
8-
docs/
9-
!docs/_config.yml
10-
!docs/CNAME

docs/CNAME renamed to CNAME

File renamed without changes.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ cd rubydoc.brew.sh
1616
bundle install
1717
ln -s $(brew --repo) brew
1818
bundle exec rake yard
19-
bundle exec jekyll serve --source docs
19+
bundle exec jekyll serve
2020
```
2121

2222
To regenerate the RubyDoc on each request to <http://localhost:8808>, run:

Rakefile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
require "rake"
22
require "rake/clean"
33

4-
DOCS_DIR = "#{__dir__}/docs"
4+
DOCS_DIR = "#{__dir__}"
55

66
task default: :yard
77

88
desc "Generate documentation with YARD"
99
task :yard do
10-
sh "find", DOCS_DIR, "-mindepth", "1", "!", "-name", "_config.yml", "!", "-name", "CNAME", "-delete"
1110
cd "brew/Library/Homebrew" do
1211
sh "bundle", "exec", "yard", "doc", "--output", DOCS_DIR
1312
end

docs/_config.yml renamed to _config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ include:
33

44
exclude:
55
- CNAME
6+
- Gemfile*
7+
- LICENSE.txt
8+
- README.md
9+
- Rakefile
10+
- vendor
611

712
plugins:
813
- jekyll-sitemap

0 commit comments

Comments
 (0)