doc: create .rdoc_options with good defaults

sparklemotion · May 24, 2023 · a2aa21a · a2aa21a
1 parent 2dc58b7
commit a2aa21a
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,7 +8,9 @@ test/test.db
 
 Gemfile.lock
 
+doc/
 gems/
+issues/
 pkg/
 ports/
 tmp/

diff --git a/.rdoc_options b/.rdoc_options
@@ -0,0 +1,31 @@
+---
+encoding: UTF-8
+static_path: []
+rdoc_include: []
+page_dir: 
+charset: UTF-8
+exclude:
+- "~\\z"
+- "\\.orig\\z"
+- "\\.rej\\z"
+- "\\.bak\\z"
+- "\\.gemspec\\z"
+- "issues"
+- "bin"
+- "rakelib"
+- "ext/sqlite3/extconf.rb"
+hyperlink_all: false
+line_numbers: false
+locale: 
+locale_dir: locale
+locale_name: 
+main_page: "README.md"
+markup: rdoc
+output_decoration: true
+show_hash: false
+skip_tests: true
+tab_width: 8
+template_stylesheets: []
+title: 
+visibility: :protected
+webcvs: 
diff --git a/rakelib/check-manifest.rake b/rakelib/check-manifest.rake
@@ -10,7 +10,9 @@ task :check_manifest do
     .git
     .github
     bin
+    doc
     gems
+    issues
     patches
     pkg
     ports
@@ -21,6 +23,7 @@ task :check_manifest do
   }
   ignore_files = %w[
     .gitignore
+    .rdoc_options
     Gemfile?*
     Rakefile
     [a-z]*.{log,out}