yard

    1

    2答えて

    私は様々な言語で長年使ってきたDoxygenの大きなファンです。特に、include imagesへのwikiのような機能に感謝し、inline DOT codeまたはexternal filesから任意のインライン図を持つGraphvizドットジェネレータを実行します。 RDocはGraphvizを使用してクラス図を生成するための図をサポートしていますが、任意の画像や図を含めることはできません。

    0

    1答えて

    私は拡張機能に侵入し、./lib/extensions/に置かれた適度なサイズのSinatraアプリケーションを作成しています。私は各ルートを文書化したいが、Yard :: Sinatraは主なapplication.rbファイルで定義されたルートだけを文書化する。 Yard :: Sinatraが何かをするように設定できますか、自分のプラグインを作成する必要がありますか?

    5

    2答えて

    私は自分のプロジェクトを文書化するのにYARDを使用しています。 YARDは、別のセクション「インスタンス属性の要約」で attr_accessor :some_attribute で作成された属性を文書化します。今私は、別の属性を持っていますが、カスタムのセッターとゲッターと def some_other_attribute ... end def some_other_at

    3

    1答えて

    LaTeX形式でRDocを生成することは可能ですか?私はRDocとYARDを見ましたが、私が必要とするものは見つけられませんでした。 Rubyで私のプロジェクトのLaTeXにドキュメントを書いています。APIリファレンスを付録や章として最終的なPDFに簡単に埋め込む方法が必要です。私にとって最も便利なのは、RubyソースファイルからLaTeXソースを生成し、適切な場所にそれを含めることです。

    4

    1答えて

    私はYardで文書化したいRubyプログラミングチュートリアルを開発しています。デフォルトでは、Yardはモジュール/クラスのすべてのメソッドをアルファベット順に置きます。しかし、チュートリアルの各モジュールのメソッドは相互に構築されているので、それらを私が書いた順序で保持したいと思います。 ヤードをに設定する方法はありません。アルファベット順にメソッドを配置しますか?

    4

    1答えて

    テンプレートを文書化するためにYARDを使用することは可能ですか、ファイル内にクラスが必要ですか?私は、インデックス/ / ヤードのdocコントローラ/モデル/ビューを実行しようとしたが、インデックスビューがピックアップされていません。私は、ドキュメント内の余分なファイルに追加されるメタデータを見ていますが、明らかに庭のコメントを表示したくありません。私はちょうど各ビューで使用される部分的な部分を

    2

    2答えて

    Engineyardにインスタンスがあり、postgisをインストールしたいと思います。 私はシェフにいくつかのことを試してみましたが、まったく成功していません。 PostgisをEngineyardにインストールした人はいますか?あなたはそれをどうやって教えてくれますか?

    2

    1答えて

    Ruby on Rails 3.1.0を使用していますが、YARD 0.7.4を使用しようとしています。 :私はyardoc(またはyard doc)コマンドは以下の通りです実行した後 # [Fixnum] Test constant documentation. TEST_CONSTANT = 1 が、HTML出力:私は私のクラスでは、私はこれを述べるので、一定の値を文書化したいと思います

    3

    3答えて

    プロダクションサーバーでYardサーバーを実行するにはどうすればよいですか? 多分いくつかのタスクを使用しますか? 乗客とnginx、Jenkins(Hudson)を使用してcapistranoからロードします。 #!/bin/sh #or you process here PROCESS='ruby */yard server' PID=`pidof $PROCESS` start()