2016-07-27 5 views
0

今、私はRuby gemを作成しようとしています。 bundle gem a_pkg_nameによって生成されたgemテンプレートを使用します。 "README.md"が自動的に作成され、デフォルトでgemのドキュメントとして使用されます。 README.md(markdown document)の代わりにREADME.org(emacsのorg-modeドキュメント)を使用できますか? 私はGitHubが "README"ファイルをサポートしており、README.mdが存在しなければREADME.orgが表示されることを知っています。ただし、gemの場合、rake buildはREADME.mdが存在しない場合はエラーを呼び出します。README.mdの代わりにREADME.mdをRuby gemパッケージに使用する方法

+0

@teksisto入力ミスを修正していただきありがとうございます。 – elgoog

答えて

1

私の推測では、あなたがエラーを取り払うますGitのリポジトリに変更をコミットし、README.mdを削除した後に問題が

spec.files   = `git ls-files -z`.split("\x0") 

にある、あります。

そして、あなたの宝石のドキュメントにREADME.orgを含めて約

は、あなたが

spec.extra_rdoc_files = ['README.org'] 
+0

完全で正確な返信をありがとう!私は私の宝石に "README.md"の代わりに "README.org"を追加することができました。 しかし、残念ながら、ヤードはemacsのorg-modeフォーマットの解析をサポートしていません。 – elgoog

2

ヤード0.9.10は現在、ORG-ルビーを使用して組織モードをサポートして、 "extra_rdoc_files" を使って、それを達成することができます。 https://github.com/lsegal/yard/pull/1133

関連する問題