doc/Rakefile.html in bigbench-0.0.3 vs doc/Rakefile.html in bigbench-0.0.4

- old
+ new

@@ -49,10 +49,12 @@ <ul> <li class="file"><a href="./Gemfile.html">Gemfile</a> + <li class="file"><a href="./README_rdoc.html">README</a> + <li class="file"><a href="./Rakefile.html">Rakefile</a> <li class="file"><a href="./lib/bigbench/help/executor_txt.html">executor</a> </ul> @@ -91,10 +93,30 @@ <li><a href="./BigBench/PostProcessor.html">BigBench::PostProcessor</a> <li><a href="./BigBench/PostProcessor/Environment.html">BigBench::PostProcessor::Environment</a> + <li><a href="./BigBench/PostProcessor/Environment/Appearings.html">BigBench::PostProcessor::Environment::Appearings</a> + + <li><a href="./BigBench/PostProcessor/Environment/AttributeCluster.html">BigBench::PostProcessor::Environment::AttributeCluster</a> + + <li><a href="./BigBench/PostProcessor/Environment/BenchmarkNotFound.html">BigBench::PostProcessor::Environment::BenchmarkNotFound</a> + + <li><a href="./BigBench/PostProcessor/Environment/Cluster.html">BigBench::PostProcessor::Environment::Cluster</a> + + <li><a href="./BigBench/PostProcessor/Environment/NormalDistribution.html">BigBench::PostProcessor::Environment::NormalDistribution</a> + + <li><a href="./BigBench/PostProcessor/Environment/PolynomialRegression.html">BigBench::PostProcessor::Environment::PolynomialRegression</a> + + <li><a href="./BigBench/PostProcessor/Environment/Statistics.html">BigBench::PostProcessor::Environment::Statistics</a> + + <li><a href="./BigBench/PostProcessor/Graphs.html">BigBench::PostProcessor::Graphs</a> + + <li><a href="./BigBench/PostProcessor/Graphs/LineGraph.html">BigBench::PostProcessor::Graphs::LineGraph</a> + + <li><a href="./BigBench/PostProcessor/Graphs/PieGraph.html">BigBench::PostProcessor::Graphs::PieGraph</a> + <li><a href="./BigBench/PostProcessor/InvalidProcessor.html">BigBench::PostProcessor::InvalidProcessor</a> <li><a href="./BigBench/PostProcessor/Processor.html">BigBench::PostProcessor::Processor</a> <li><a href="./BigBench/PostProcessor/Statistics.html">BigBench::PostProcessor::Statistics</a> @@ -109,10 +131,12 @@ <li><a href="./BigBench/Tracker.html">BigBench::Tracker</a> <li><a href="./BigBench/Tracker/Tracker.html">BigBench::Tracker::Tracker</a> + <li><a href="./Array.html">Array</a> + <li><a href="./EventMachineLoop.html">EventMachineLoop</a> <li><a href="./Float.html">Float</a> <li><a href="./Helpers.html">Helpers</a> @@ -125,23 +149,55 @@ </div> </nav> <div id="documentation" class="description"> -<p>require “bundler/gem_tasks” require “rack”</p> +<p>require “bundler/gem_tasks” require “rack” require “RedCloth” require +“redcloth-formatters-rdoc” require “rdoc/task”</p> -<p>namespace :bigbench do</p> +<p>desc “Create and open documentation” task :doc do</p> -<pre class="ruby"><span class="ruby-identifier">desc</span> <span class="ruby-string">&quot;Create and open documentation&quot;</span> -<span class="ruby-identifier">task</span> :<span class="ruby-identifier">doc</span> <span class="ruby-keyword">do</span> - <span class="ruby-value">%xrdoc --main BigBench --include lib/bigbench/help/ &amp;&amp; open doc/index.html`</span> -<span class="ruby-keyword">end</span> +<pre class="ruby"><span class="ruby-comment"># Compile the readme to the rdoc format</span> +<span class="ruby-identifier">readme_textile</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">'README.textile'</span>, <span class="ruby-string">'r+'</span>){ <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">read</span> } +<span class="ruby-identifier">readme_rdoc</span> = <span class="ruby-constant">RedCloth</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">readme_textile</span>).<span class="ruby-identifier">to_rdoc</span> +<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">'README.rdoc'</span>, <span class="ruby-string">'w+'</span>){ <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">readme_rdoc</span>) } -<span class="ruby-identifier">desc</span> <span class="ruby-string">&quot;Start Thin RDoc Testserver&quot;</span> -<span class="ruby-identifier">task</span> :<span class="ruby-identifier">testserver</span> <span class="ruby-keyword">do</span> - <span class="ruby-identifier">load</span> <span class="ruby-string">&quot;spec/lib/test_web_server.rb&quot;</span> - <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span><span class="ruby-operator">::</span><span class="ruby-constant">Thin</span>.<span class="ruby-identifier">run</span> <span class="ruby-constant">Sinatra</span><span class="ruby-operator">::</span><span class="ruby-constant">Application</span>, :<span class="ruby-constant">Port</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">3001</span> +<span class="ruby-comment"># Create rdoc with the readme as main file</span> +<span class="ruby-value">%xrdoc --main README.rdoc --include lib/bigbench/help/`</span> + +<span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rdoc</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">main</span> = <span class="ruby-string">&quot;README.rdoc&quot;</span> + <span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">rdoc_files</span>.<span class="ruby-identifier">include</span>(<span class="ruby-string">&quot;README.rdoc&quot;</span>, <span class="ruby-string">&quot;lib/bigbench/help/&quot;</span>) <span class="ruby-keyword">end</span> + +<span class="ruby-comment"># Fix RDocs inability to handle tables</span> +<span class="ruby-identifier">index_html</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">'doc/index.html'</span>, <span class="ruby-string">'r+'</span>){ <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">read</span> } +<span class="ruby-identifier">index_html</span>.<span class="ruby-identifier">gsub!</span> <span class="ruby-string">'&amp;lt;'</span>, <span class="ruby-string">'&lt;'</span> +<span class="ruby-identifier">index_html</span>.<span class="ruby-identifier">gsub!</span> <span class="ruby-string">'&amp;gt;'</span>, <span class="ruby-string">'&gt;'</span> +<span class="ruby-identifier">index_html</span>.<span class="ruby-identifier">gsub!</span> <span class="ruby-string">'&lt;p&gt;&lt;table&gt;&lt;/p&gt;'</span>, <span class="ruby-string">'&lt;table&gt;'</span> +<span class="ruby-identifier">index_html</span>.<span class="ruby-identifier">gsub!</span> <span class="ruby-string">'&lt;pre&gt;&lt;tr&gt;'</span>, <span class="ruby-string">'&lt;tr&gt;'</span> +<span class="ruby-identifier">index_html</span>.<span class="ruby-identifier">gsub!</span> <span class="ruby-string">'&lt;/tr&gt;&lt;/pre&gt;'</span>, <span class="ruby-string">'&lt;/tr&gt;'</span> +<span class="ruby-identifier">index_html</span>.<span class="ruby-identifier">gsub!</span> <span class="ruby-string">'&lt;p&gt;&lt;/table&gt;&lt;/p&gt;'</span>, <span class="ruby-string">'&lt;/table&gt;'</span> +<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">'doc/index.html'</span>, <span class="ruby-string">'w+'</span>){ <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">index_html</span>) } + +<span class="ruby-comment"># Add table style</span> +<span class="ruby-identifier">rdoc_css</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">'doc/rdoc.css'</span>, <span class="ruby-string">'r+'</span>){ <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">read</span> } +<span class="ruby-identifier">rdoc_css</span> <span class="ruby-operator">+=</span> <span class="ruby-node">&quot;\n table{ border: 1px dashed #D3D3D3; line-height: 30px; margin-top: 10px; border-collapse: collapse; }&quot;</span> +<span class="ruby-identifier">rdoc_css</span> <span class="ruby-operator">+=</span> <span class="ruby-node">&quot;\n td{ padding-left:20px; padding-right:20px; border-top: 1px solid #E4E4E4; }&quot;</span> +<span class="ruby-identifier">rdoc_css</span> <span class="ruby-operator">+=</span> <span class="ruby-string">&quot;\n th{ padding-left:20px; padding-right:20px; text-align:left; }&quot;</span> +<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">'doc/rdoc.css'</span>, <span class="ruby-string">'w+'</span>){ <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">rdoc_css</span>) } + +<span class="ruby-comment"># Clean up the rdoc file</span> +<span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">&quot;README.rdoc&quot;</span>) +<span class="ruby-value">%xopen doc/index.html`</span> +</pre> + +<p>end</p> + +<p>desc “Start Thin RDoc Testserver” task :server do</p> + +<pre class="ruby"><span class="ruby-identifier">load</span> <span class="ruby-string">&quot;spec/lib/test_web_server.rb&quot;</span> +<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span><span class="ruby-operator">::</span><span class="ruby-constant">Thin</span>.<span class="ruby-identifier">run</span> <span class="ruby-constant">Sinatra</span><span class="ruby-operator">::</span><span class="ruby-constant">Application</span>, :<span class="ruby-constant">Port</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">3001</span> </pre> <p>end</p> </div>