hiki2yard 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dea9d3f8d30290d68b415caa381334cda8bbc80
-  data.tar.gz: 1d8329b5fa7a7bc39b5c52181283d23f1c8747f1
+  metadata.gz: c04bad8d7ed595e5e441799caf54f9cce18f01c6
+  data.tar.gz: e5a16fdeb2704ffd04fb4372369beb946b6b89aa
 SHA512:
-  metadata.gz: 1b10974eb32c5e43b61c6b801762ffee5cb1cb54b071bb5b87d3db06de22fc752c1f5754b81e29b019adbb39ad82d7b7d062eb348257188722ab4977e9dac46c
-  data.tar.gz: 12558bb962caf426b3e6dde17fa1d9dd0a1a0621f3a05f8a8d8e33d6ce5622f3354830be8aba2dd638d539419a95dac9bb073646c810d17633f7080e135672e4
+  metadata.gz: 323db907551374ab384095f847a50e60109c74a9239947e5f6f4cf47b7282662084247af91ce6275099770fd1848282d1f217502cee32e193e56cdd2f74c6621
+  data.tar.gz: 3e6cd4016893ffe5fea30ebf920cac2b93412e44ee6e3e44cacaed312ecdd1a4ce044bf10697cbbec4b6e2b2cdd01b252887b11826be5ad15c6c7cebcf49be6d

data/.gitignore

@@ -3,7 +3,8 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/
+/doc/
+/wiki/

data/.yardopts

@@ -1,2 +1,3 @@
+-t mathjax -p templates
 -
 **/*.md

data/Rakefile

@@ -33,10 +33,31 @@ task :hiki2md do
   readme_en="#{basename}.wiki/README_en.md"
   readme_ja="#{basename}.wiki/README_ja.md"
   if File.exists?(readme_en)
-    FileUtils.cp(readme_en,"./README.md",:verbose=>true)  
+    FileUtils.cp(readme_en,"./README.md",:verbose=>true)
   elsif File.exists?(readme_ja)
     FileUtils.cp(readme_ja,"./README.md",:verbose=>true)
     FileUtils.cp(readme_ja,"#{basename}.wiki/Home.md",:verbose=>true)
   end
 end
 
+desc "transfer hikis/*.hiki to latex"
+task :latex do
+  p Dir.glob('./hikis/*')
+  targets = ['handout_sample','TexManual','sakibts']
+  targets.each{|target|
+    p command = "hiki2latex --pre latexes/handout_pre.tex hikis/#{target}.hiki > latexes/#{target}.tex"
+    system command
+    command = "open latexes/#{target}.tex"
+    system command
+  }
+end
+
+desc "arrange yard target by mathjax-yard"
+task :pre_math do
+  system('mathjax-yard')
+end
+
+desc "make yard documents with yardmath"
+task :myard => [:hiki2md, :pre_math,:yard] do
+  system('mathjax-yard --post')
+end

data/hiki2yard.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_development_dependency "hiki2md"
   spec.add_development_dependency "mathjax-yard"
+  spec.add_development_dependency "hiki2latex"
 end

data/hiki2yard.wiki/TexManual.md

@@ -0,0 +1,25 @@
+# TexManual
+
+## teXShopの設定
+1. 『設定』 $\rightarrow$ ︎書類 $\rightarrow$ ︎エンコーディング $\rightarrow$ Unicode(UTF-8)
+1. 『設定プロファイル』$\rightarrow$ pTeX(ptex2pdf)を選択
+1. TeXShopを再起動
+
+## 必要なgemの確認
+- gem listコマンドを入力,以下のgemが入っているか確認
+  - hikidoc
+  - hikiutils
+- ︎︎無ければ(sudo) gem install hogehogeで入れる
+
+## 入力の方法
+- open -a mi hogehogeでファイルを開き,入力していく
+
+## 作ったtextをページにして表示
+- hiki -e hogehoge で編集
+- hiki -u hogehoge で表示
+
+## pdfファイルへの変換方法
+1. hiki2latex hogehoge.hiki $>$ hogehoge.tex
+1. hikidoc hogehoge.hiki $>$ hogehoge.html
+1. open hogehoge.tex
+1. TeXShopが開く. 左上のタイプセットを押すとpdfファイルが出力される

data/hiki2yard.wiki/handout_sample.md

@@ -0,0 +1,73 @@
+# title:hiki2yardによる数値計算資料の作成システム
+# author:情報科学科 西谷研究室 1234 西谷滋人
+
+# 目的
+hikiフォーマット文書をlatexフォーマットに変換するhiki2latex[1]をもちいて中間発表のabstract資料を作成する手順を紹介する．
+
+# インストール
+最初に，作業を自動化するhiki2yard[2]をrubygemsからinstallする．terminal上で，
+```
+gem install hiki2yaml
+```
+によって環境を構築するCUIがinstallされる．
+```
+hiki2yard --version
+```
+によってversionが表示されれば，正常にinstallがなされていることが確認できる．
+
+# 環境構築
+terminal上で
+```
+hiki2yard --init
+```
+によって，必要となるファイルが自動的に配置される．指示に従って，hogehoge.gemspecを
+手動で修正する必要がある．さらに，
+```
+bundle update
+```
+によって，必要なgem filesがinstallされる．
+
+# directory構成と各ファイルの意味
+次にdirectory構成を示す．これはbundle gem -bによって生成される標準gem構築環境に修正を加えた構成となる．
+```
+bob% tree .
+.
+├── CODE_OF_CONDUCT.md
+├── Gemfile
+├── Gemfile.lock
+├── LICENSE.txt
+├── README.md
+├── Rakefile
+├── bin
+├── doc
+├── exe
+├── hiki2yard.gemspec
+├── hiki2yard.wiki
+├── hikis
+│   ├── README_en.hiki
+│   ├── handout_sample.hiki
+...
+├── latexes
+│   ├── handout_pre.tex
+├── lib
+├── pkg
+└── spec
+```
+hikisにtargetとなるfileをhiki構文で作る．Rakefileに必要なtaskが登録されている．latexesには現在のところ，中間発表のhandoutを生成するpre-formatのtexが置かれている．
+```
+rake latex
+```
+によって
+```
+hiki2latex --pre latexes/handout_pre.tex hikis/handout_sample.hiki > latexes/handout_sample.tex
+```
+が起動され，latexes上にtargetのtex format文書が生成される．この後，自動的に起動されるmacのapplicationであるTeXShop上でcommand-tを押下することで，latexからpdfへ変換を行い，中間発表のabstractを作成する．
+
+# 個別の準備
+- 各人は自分でhikis/hogehoge.hikiファイルを生成する
+- Rakefileの:latexタスクにあるtarget変数を変更する
+後は，マニュアルに従ってpdf文書を作成できるはずである．質問がある場合は早めにね．
+
+# 参考資料
+1. [hiki2latex](https://rubygems.org/gems/hiki2latex), 2016/08/11アクセス．
+1. [sakibts/hiki2yard](https://github.com/sakibts/hiki2yard), 2016/08/11アクセス．

data/hiki2yard.wiki/md2yard.md

@@ -0,0 +1,50 @@
+# 概要
+
+rake yardでdoc/file.*.htmlを作成した時に，うまくcodeがhighlight変換されない．
+
+# 経過
+8/3のゼミでerinjinuへ説明しているときに，俺のでは正常に変換されるのに，erijinuのmac上では変換されないことが判明
+
+## rake yardでpreがうまく通らない理由
+- 原因不明
+- おれが，yardをいじっちゃったのかも．得にcodeの前後にpreをつけたような記憶が．．．
+- ただそれがどこにあるのか不明．version変わってるので，消えてると思うんやけど．
+- もう少し探してみます．
+
+### 対策
+とりあえず，wikiで登録するようにした．なんかしらんけど，直接あげられるし．
+
+# 作業メモ
+とりあえず，/usr/local/lib/ruby/gems/2.2.0/gems/yard-0.9.5で穴をほってみたが，お宝は，見当たらず．
+## 原因コードの場所
+```tcsh
+lib/yard/templates/helpers/html_helper.rb:        html.gsub(/<pre\s*(?:lang="(.+?)")?>(?:\s*<code\s*(?:class="(.+?)")?\s*>)?(.+?)(?:<\/code>\s*)?<\/pre>/m) do
+lib/yard/templates/helpers/html_helper.rb:          %Q{<pre class="#{classes}"><code class="#{language}">#{string}</code></pre>}
+
+emacs lib/yard/templates/helpers/html_helper.rb
+
+
+templates/default/tags/html/example.erb:      <pre class="example code"><code><%= html_syntax_highlight(tag.text) %></code></pre>
+```
+html_helper.rbに記述があるが，ちゃんと動いているようで，erijinuでなぜ動かないかが不明．erijinuでdebugが必要か．．．
+
+## その他
+```
+
+bob% grep "<code" */*/*/*.*rb
+spec/templates/helpers/html_helper_spec.rb:      expect(html).to match %r{^<p>Introduction:</p>.*<code class="ruby">}m
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify('<pre><code>def x; end</code></pre>', :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code NAME"><code class="NAME">foobar</code></pre>')
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify("<pre><code>!!!LANG\ndef x; end</code></pre>", :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code LANG"><code class="LANG">foobar</code></pre>')
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify('<pre lang="foo"><code>{"foo" => 1}</code></pre>', :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code foo"><code class="foo">{&quot;foo&quot; =&gt; 1}</code></pre>')
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify('<pre lang="foo"><code>x = 1</code></pre>', :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code foo"><code class="foo">x = 1</code></pre>')
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify('<pre><code class="foo">x = 1</code></pre>', :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code foo"><code class="foo">x = 1</code></pre>')
+[bob:2.2.0/gems/yard-0.9.5] bob% grep "<code" */*/*/*/*.*rb
+spec/templates/helpers/markup/rdoc_markup_spec.rb:      expect(to_html('Hello +<code>+')).to eq '<p>Hello <tt>&lt;code&gt;</tt></p>'
+spec/templates/helpers/markup/rdoc_markup_spec.rb:      expect(fix_typewriter("<code>Hello +hello+</code>")).to eq "<code>Hello +hello+</code>"
+
+他のはspecばかり．

data/hiki2yard.wiki/saki.md

@@ -0,0 +1,5 @@
+hiki2yard
+
+ここに打ち込む
+hikiをyardに変換するコマンドを提供することが目標
+hello.

data/hiki2yard.wiki/sakibts.md

@@ -0,0 +1,50 @@
+# title
+yardによる数値計算関連文書作成システムの構築
+
+# 概要
+## hiki2yardで何を目指すか?
+rubyのgem directoryは，すべての開発者がはじめてそのコードを見た時にも迷わないように，決まった構造になっています．特にdocディレクトリーはrubygemsでのdocumentのデフォルトディレクトリーとして，*.wikiディレクトリーはgithubのwikiのデフォルトディレクトリーとして用意されています．このディレクトリーに対して，それぞれのrubygems, githubシステムがoperationを行い，初めて利用するユーザあるいは開発者に対して必要な情報を提供するように意図されています．
+
+我々がhiki2yardで目指すものも同じです．
+
+
+
+# 作業（16/8/4）
+以下の作業を今週中にやってください．
+1. hiki2latexをhiki2yard.gemspecに入れて，bundle updateで取ってくる．
+1. hiki2latexを動かしてみる．
+  1. [nishitani0のDocumentWriting](http://nishitani0.kwansei.ac.jp/~bob/nishitani0/Internal/DocumentWriting.html)にある，hiki2latex, 手順・コツ，幾つかのformatひな形を読んでいれてみてください．
+1. Rakefileにsakibts.hikiをlatex/sakibts.texに変換するruby codeを書く．
+
+できないとみんなの中間発表用のabstractが作れません．がんばってね．
+
+# 幾つかの注意(16/8/17)
+updateされたのに対する幾つかの注意です．
+
+## システムについての注意
+- directoryのなかで，何処にfileを置くかは決めてあります．なぜかは概要に書きました．勝手にdirecotryを作るのではなく，今あるdirectoryの中での操作をRakefileに書き加えるようにしてください．
+  - tex_sampleは不用ですので，削除してください．
+- hikis/TexManual.hikiに移しました．そこから自動でlatexesへ生成するようにRakefileを修正しています．
+
+## hikiの記述に関する注意
+- number listは\#で書いていく．
+- へんな記号は使わない．右三角．これは，latexで解釈できないため，変換されないためです．
+- $\rightarrow$を使う．ただし，hikiでの表示ができていない．これは，hiki2yardではできません．
+  - mathjaxを使えるようにします．その手順は次に記述します．
+
+## mathjax-yardについて
+標準yardで変換されるmdファイル内で，数式を表示することを可能にする拡張機能です．yard処理の前後にmathjaxのための処理を挟んで，標準的なgemディレクトリ内にあるmdファイルをdoc/file.**に変換後にlatex記法の数式を表示します．
+
+### 操作法
+```
+gem install mathjax-yard
+```
+でinstall.
+```
+mathjax-yard -i
+```
+でinitしてくれます．後は，　
+```
+rake myard
+```
+でyardがhtmlに自動的に変換してくれます．

data/hikis/TexManual.hiki

@@ -0,0 +1,25 @@
+!TexManual
+
+!!teXShopの設定
+#『設定』 $\rightarrow$ ︎書類 $\rightarrow$ ︎エンコーディング $\rightarrow$ Unicode(UTF-8)
+#『設定プロファイル』$\rightarrow$ pTeX(ptex2pdf)を選択
+# TeXShopを再起動
+
+!!必要なgemの確認
+*gem listコマンドを入力,以下のgemが入っているか確認
+**hikidoc
+**hikiutils
+*︎︎無ければ(sudo) gem install hogehogeで入れる
+
+!!入力の方法
+*open -a mi hogehogeでファイルを開き,入力していく
+
+!!作ったtextをページにして表示
+*hiki -e hogehoge で編集
+*hiki -u hogehoge で表示
+
+!!pdfファイルへの変換方法
+# hiki2latex hogehoge.hiki $>$ hogehoge.tex
+# hikidoc hogehoge.hiki $>$ hogehoge.html
+# open hogehoge.tex
+# TeXShopが開く. 左上のタイプセットを押すとpdfファイルが出力される

data/hikis/handout_sample.hiki

@@ -0,0 +1,61 @@
+!title:hiki2yardによる数値計算資料の作成システム
+!author:情報科学科 西谷研究室 1234 西谷滋人
+
+!目的
+hikiフォーマット文書をlatexフォーマットに変換するhiki2latex[1]をもちいて中間発表のabstract資料を作成する手順を紹介する．
+
+!インストール
+最初に，作業を自動化するhiki2yard[2]をrubygemsからinstallする．terminal上で，
+ gem install hiki2yaml
+によって環境を構築するCUIがinstallされる．
+ hiki2yard --version
+によってversionが表示されれば，正常にinstallがなされていることが確認できる．
+
+!環境構築
+terminal上で
+ hiki2yard --init
+によって，必要となるファイルが自動的に配置される．指示に従って，hogehoge.gemspecを
+手動で修正する必要がある．さらに，
+ bundle update
+によって，必要なgem filesがinstallされる．
+
+!directory構成と各ファイルの意味
+次にdirectory構成を示す．これはbundle gem -bによって生成される標準gem構築環境に修正を加えた構成となる．
+<<< 
+bob% tree .
+.
+├── CODE_OF_CONDUCT.md
+├── Gemfile
+├── Gemfile.lock
+├── LICENSE.txt
+├── README.md
+├── Rakefile
+├── bin
+├── doc
+├── exe
+├── hiki2yard.gemspec
+├── hiki2yard.wiki
+├── hikis
+│   ├── README_en.hiki
+│   ├── handout_sample.hiki
+...
+├── latexes
+│   ├── handout_pre.tex
+├── lib
+├── pkg
+└── spec
+>>>
+hikisにtargetとなるfileをhiki構文で作る．Rakefileに必要なtaskが登録されている．latexesには現在のところ，中間発表のhandoutを生成するpre-formatのtexが置かれている．
+ rake latex
+によって
+ hiki2latex --pre latexes/handout_pre.tex hikis/handout_sample.hiki > latexes/handout_sample.tex
+が起動され，latexes上にtargetのtex format文書が生成される．この後，自動的に起動されるmacのapplicationであるTeXShop上でcommand-tを押下することで，latexからpdfへ変換を行い，中間発表のabstractを作成する．
+
+!個別の準備
+* 各人は自分でhikis/hogehoge.hikiファイルを生成する
+* Rakefileの:latexタスクにあるtarget変数を変更する
+後は，マニュアルに従ってpdf文書を作成できるはずである．質問がある場合は早めにね．
+
+!参考資料
+# [[hiki2latex|https://rubygems.org/gems/hiki2latex]], 2016/08/11アクセス．
+# [[sakibts/hiki2yard|https://github.com/sakibts/hiki2yard]], 2016/08/11アクセス．

data/hikis/md2yard.hiki

@@ -0,0 +1,50 @@
+!概要
+
+rake yardでdoc/file.*.htmlを作成した時に，うまくcodeがhighlight変換されない．
+
+!経過
+8/3のゼミでerinjinuへ説明しているときに，俺のでは正常に変換されるのに，erijinuのmac上では変換されないことが判明
+
+!!rake yardでpreがうまく通らない理由
+* 原因不明
+* おれが，yardをいじっちゃったのかも．得にcodeの前後にpreをつけたような記憶が．．．
+* ただそれがどこにあるのか不明．version変わってるので，消えてると思うんやけど．
+* もう少し探してみます．
+
+!!!対策
+とりあえず，wikiで登録するようにした．なんかしらんけど，直接あげられるし．
+
+!作業メモ
+とりあえず，/usr/local/lib/ruby/gems/2.2.0/gems/yard-0.9.5で穴をほってみたが，お宝は，見当たらず．
+!!原因コードの場所
+<<< tcsh
+lib/yard/templates/helpers/html_helper.rb:        html.gsub(/<pre\s*(?:lang="(.+?)")?>(?:\s*<code\s*(?:class="(.+?)")?\s*>)?(.+?)(?:<\/code>\s*)?<\/pre>/m) do
+lib/yard/templates/helpers/html_helper.rb:          %Q{<pre class="#{classes}"><code class="#{language}">#{string}</code></pre>}
+
+emacs lib/yard/templates/helpers/html_helper.rb
+
+
+templates/default/tags/html/example.erb:      <pre class="example code"><code><%= html_syntax_highlight(tag.text) %></code></pre>
+>>>
+html_helper.rbに記述があるが，ちゃんと動いているようで，erijinuでなぜ動かないかが不明．erijinuでdebugが必要か．．．
+
+!!その他
+<<<
+
+bob% grep "<code" */*/*/*.*rb
+spec/templates/helpers/html_helper_spec.rb:      expect(html).to match %r{^<p>Introduction:</p>.*<code class="ruby">}m
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify('<pre><code>def x; end</code></pre>', :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code NAME"><code class="NAME">foobar</code></pre>')
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify("<pre><code>!!!LANG\ndef x; end</code></pre>", :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code LANG"><code class="LANG">foobar</code></pre>')
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify('<pre lang="foo"><code>{"foo" => 1}</code></pre>', :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code foo"><code class="foo">{&quot;foo&quot; =&gt; 1}</code></pre>')
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify('<pre lang="foo"><code>x = 1</code></pre>', :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code foo"><code class="foo">x = 1</code></pre>')
+spec/templates/helpers/html_helper_spec.rb:      expect(subject.htmlify('<pre><code class="foo">x = 1</code></pre>', :html)).to eq(
+spec/templates/helpers/html_helper_spec.rb:        '<pre class="code foo"><code class="foo">x = 1</code></pre>')
+[bob:2.2.0/gems/yard-0.9.5] bob% grep "<code" */*/*/*/*.*rb
+spec/templates/helpers/markup/rdoc_markup_spec.rb:      expect(to_html('Hello +<code>+')).to eq '<p>Hello <tt>&lt;code&gt;</tt></p>'
+spec/templates/helpers/markup/rdoc_markup_spec.rb:      expect(fix_typewriter("<code>Hello +hello+</code>")).to eq "<code>Hello +hello+</code>"
+
+他のはspecばかり．

data/hikis/saki.hiki

@@ -0,0 +1,5 @@
+hiki2yard
+
+ここに打ち込む
+hikiをyardに変換するコマンドを提供することが目標
+hello.

data/hikis/saki.hiki~

@@ -0,0 +1,4 @@
+hiki2yard
+ここに打ち込む
+hikiをyardに変換するコマンドを提供することが目標
+hello.

data/hikis/sakibts.hiki

@@ -0,0 +1,44 @@
+!title
+yardによる数値計算関連文書作成システムの構築
+
+!概要
+!!hiki2yardで何を目指すか?
+rubyのgem directoryは，すべての開発者がはじめてそのコードを見た時にも迷わないように，決まった構造になっています．特にdocディレクトリーはrubygemsでのdocumentのデフォルトディレクトリーとして，*.wikiディレクトリーはgithubのwikiのデフォルトディレクトリーとして用意されています．このディレクトリーに対して，それぞれのrubygems, githubシステムがoperationを行い，初めて利用するユーザあるいは開発者に対して必要な情報を提供するように意図されています．
+
+我々がhiki2yardで目指すものも同じです．
+
+
+
+!作業（16/8/4）
+以下の作業を今週中にやってください．
+# hiki2latexをhiki2yard.gemspecに入れて，bundle updateで取ってくる．
+# hiki2latexを動かしてみる．
+##[[nishitani0のDocumentWriting|http://nishitani0.kwansei.ac.jp/~bob/nishitani0/Internal/DocumentWriting.html]]にある，hiki2latex, 手順・コツ，幾つかのformatひな形を読んでいれてみてください．
+# Rakefileにsakibts.hikiをlatex/sakibts.texに変換するruby codeを書く．
+
+できないとみんなの中間発表用のabstractが作れません．がんばってね．
+
+!幾つかの注意(16/8/17)
+updateされたのに対する幾つかの注意です．
+
+!!システムについての注意
+* directoryのなかで，何処にfileを置くかは決めてあります．なぜかは概要に書きました．勝手にdirecotryを作るのではなく，今あるdirectoryの中での操作をRakefileに書き加えるようにしてください．
+** tex_sampleは不用ですので，削除してください．
+* hikis/TexManual.hikiに移しました．そこから自動でlatexesへ生成するようにRakefileを修正しています．
+
+!!hikiの記述に関する注意
+* number listは\#で書いていく．
+* へんな記号は使わない．右三角．これは，latexで解釈できないため，変換されないためです．
+* $\rightarrow$を使う．ただし，hikiでの表示ができていない．これは，hiki2yardではできません．
+** mathjaxを使えるようにします．その手順は次に記述します．
+
+!!mathjax-yardについて
+標準yardで変換されるmdファイル内で，数式を表示することを可能にする拡張機能です．yard処理の前後にmathjaxのための処理を挟んで，標準的なgemディレクトリ内にあるmdファイルをdoc/file.**に変換後にlatex記法の数式を表示します．
+
+!!!操作法
+ gem install mathjax-yard
+でinstall.
+ mathjax-yard -i
+でinitしてくれます．後は，　
+ rake myard
+でyardがhtmlに自動的に変換してくれます．