Skip to content

Commit a2aa21a

Browse files
committed
doc: create .rdoc_options with good defaults
1 parent 2dc58b7 commit a2aa21a

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ test/test.db
88

99
Gemfile.lock
1010

11+
doc/
1112
gems/
13+
issues/
1214
pkg/
1315
ports/
1416
tmp/

.rdoc_options

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
encoding: UTF-8
3+
static_path: []
4+
rdoc_include: []
5+
page_dir:
6+
charset: UTF-8
7+
exclude:
8+
- "~\\z"
9+
- "\\.orig\\z"
10+
- "\\.rej\\z"
11+
- "\\.bak\\z"
12+
- "\\.gemspec\\z"
13+
- "issues"
14+
- "bin"
15+
- "rakelib"
16+
- "ext/sqlite3/extconf.rb"
17+
hyperlink_all: false
18+
line_numbers: false
19+
locale:
20+
locale_dir: locale
21+
locale_name:
22+
main_page: "README.md"
23+
markup: rdoc
24+
output_decoration: true
25+
show_hash: false
26+
skip_tests: true
27+
tab_width: 8
28+
template_stylesheets: []
29+
title:
30+
visibility: :protected
31+
webcvs:

rakelib/check-manifest.rake

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ task :check_manifest do
1010
.git
1111
.github
1212
bin
13+
doc
1314
gems
15+
issues
1416
patches
1517
pkg
1618
ports
@@ -21,6 +23,7 @@ task :check_manifest do
2123
}
2224
ignore_files = %w[
2325
.gitignore
26+
.rdoc_options
2427
Gemfile?*
2528
Rakefile
2629
[a-z]*.{log,out}

0 commit comments

Comments
 (0)