Add a bit of documentation, install yard

sidekiq · Jun 8, 2022 · 6eadad8 · 6eadad8
1 parent c76be23
commit 6eadad8
Show file tree

Hide file tree

Showing 78 changed files with 6,008 additions and 8 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/Gemfile b/Gemfile
@@ -9,7 +9,7 @@ gem "rails", "~> 6.0"
 gem "sqlite3", platforms: :ruby
 gem "activerecord-jdbcsqlite3-adapter", platforms: :jruby
 gem "after_commit_everywhere"
-
+gem "yard"
 # mail dependencies
 gem "net-smtp", platforms: :mri, require: false
 

diff --git a/Rakefile b/Rakefile
@@ -1,6 +1,16 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 require "standard/rake"
+require "rdoc/task"
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "docs/rdoc.rdoc"
+  rdoc.rdoc_files.include("docs/rdoc.rdoc",
+                          "lib/sidekiq/api.rb",
+                          "lib/sidekiq/client.rb",
+                          "lib/sidekiq/worker.rb",
+                          "lib/sidekiq/job.rb")
+end
 
 Rake::TestTask.new(:test) do |test|
   test.warning = true

diff --git a/docs/rdoc.rdoc b/docs/rdoc.rdoc
diff --git a/html/Sidekiq.html b/html/Sidekiq.html
@@ -0,0 +1,118 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Sidekiq - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/jquery.js"></script>
+<script src="./js/darkfish.js"></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+
+
+  <div id="class-metadata">
+
+
+
+
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Sidekiq">
+  <h1 id="module-Sidekiq" class="module">
+    module Sidekiq
+  </h1>
+
+  <section class="description">
+
+  </section>
+
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+    <section class="constants-list">
+      <header>
+        <h3>Constants</h3>
+      </header>
+      <dl>
+
+        <dt id="Job">Job
+
+        <dd><p><a href="Sidekiq.html#Job">Sidekiq::Job</a> is a new alias for <a
+href="Sidekiq/Worker.html">Sidekiq::Worker</a> as of <a
+href="Sidekiq.html">Sidekiq</a> 6.3.0. Use `include Sidekiq::Job` rather
+than `include Sidekiq::Worker`.</p>
+
+<p>The term “worker” is too generic and overly confusing, used in several
+different contexts meaning different things. Many people call a <a
+href="Sidekiq.html">Sidekiq</a> process a “worker”. Some people call the
+thread that executes jobs a “worker”. This change brings <a
+href="Sidekiq.html">Sidekiq</a> closer to ActiveJob where your job classes
+extend ApplicationJob.</p>
+
+
+      </dl>
+    </section>
+
+
+
+
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.0.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+