問題タブ [haddock]

Haddock は空白行をサポートし、REPL の例をサポートします。しかし、例で空白行を表示する方法がわかりません。

たとえば、'f' が空白行で区切られた 2 行を出力する場合

対応する Haddock の例

生成するだけ

2行目

つまり、最初の空白行で例を終了し、その後を通常のコメントとして扱います。

Haddock REPL の例で空白のいいねを表示する方法はありますか?

ドキュメントをカスタマイズする方法がわかりません

生成します。たとえば、ソース リンクを含めたり、すべての場合に適用されるようにカスタム CSS ファイルを使用するにはどうすればよいでしょうか?

私の~/.cabal/config中で私は試しました

しかし、これらの設定がどのような範囲であるかは不明です。

Haddock によって生成されたすべてのドキュメントのデフォルトのドキュメント生成をカスタマイズするにはどうすればよいですcabal haddockか?cabal installcabal sdist

ライブラリで を実行してからcabal buildファイルを変更すると、次に を実行するときにcabal build、変更の影響を受けるファイルを再コンパイルするだけで済みます。コマンドで同じ動作が得られませんcabal haddock。ファイルを変更した後に実行すると、cabal/haddock は以前の作業をすべて破棄し、最初からやり直すことになります。これにはかなり時間がかかります。ドキュメントの差分更新を取得する方法はありますか?

これは、ドキュメントを生成するためのコマンド cabal の問題のダンプです。

Haddock スタイルでコードに注釈を付けて、ブラウズ可能なドキュメントを生成したいと考えています。私もスタックを使っているので、ドキュメント生成をワークフローに統合したいです。ただし、まだ有用なものを生成できていません。

走れる

そして、それは私が望むスタイルでドキュメントを生成します ( の奥深くにあります~/.stack/) が、自分のコードではなく、依存しているパッケージのドキュメントのみを生成するようです。

私が走るとき

--haddock追加の引数を使用して、自分のプロジェクトのドキュメントを生成--no-haddock-depsし、依存関係のドキュメントを省略できるという印象を受けました。ただし、実行すると

何も起こらないようです。最初にstack cleanすべてのコードを再コンパイルすると、ドキュメントに何らかの形で関連しているように見える出力が生成されません。

中間的な解決策として、Haddock を単独で実行してみました。つまり、

しかし、ファイルが依存するモジュールが見つからないというエラーが表示されます(スタックによってローカルにインストールされます)。これは、ドキュメントの生成が何らかの方法でスタックを通過する必要があるという印象を与えます。.cabal私は探しましたが、ドキュメント用の myおよびstack.yamlfiles の構成に関連する説明は実際には見つかりませんでした。

TL;DR

スタックと Haddock を使用して、自分のパッケージ内のコードのドキュメントを生成するにはどうすればよいですか?

一部のパッケージ ( Data.String.Utilsなどの Haddock ドキュメント) には、ドキュメントの表示に使用されるスタイルを選択できる「スタイル」メニューを含むメニューバーがあります。

自分のパッケージのドキュメントでこのメニューを取得するにはどうすればよいですか? それを含めるにはどの設定を使用する必要がありますか? また、提供するスタイルを指定するにはどうすればよいですか?

私は次のようなことを試しました

と

私の中で~/.cabal/config; ただし、前者は失敗し、後者は最後にリストされcssたエントリを使用してフォーマットするだけで、「スタイル」メニューはありません。

Haddock REPL の例での割り当ての正しいイディオムは何ですか? 具体的には、使用する必要がありますlet

(そのまま — まだ — GHCi が期待する) または省略する

（IHaskellでできるように）？

更新: この質問は現在古くなっています。Hackage は Haskell バージョン 7.10.2 を使用してビルドするようになったため、次のような障害は発生しません。この変更により、回答に記載されているスクリプトの一部が壊れているようにも見えます。

Haskell パッケージのドキュメントを Hackage で取得するにはどうすればよいですか?

そのハックがそれらを構築するものを理解していますが、エラーが発生します

パッケージの要件をダウングレードすることができず (これが自動ビルドの障害になっているようです)、一部のパッケージで「ユーザーがアップロードしたドキュメント」と表示されています。ただし、ビルドの試みは失敗します (以下を参照してください)。

Haskell パッケージのドキュメントを Hackage で取得するにはどうすればよいですか? 特に、自分でアップロードするにはどうすればよいですか?

試してみました

しかし得る

無効なドキュメント tarball: tar アーカイブ内のファイルが、予期されるディレクトリ 'MyPackage-0.1.0.2-docs' にありません

以下にリンクされているいくつかのスクリプトの独自のバージョンも試しましたが、同じエラーが発生します。

私が呼び出す

しかし、同じエラーが発生します。

Haskell パッケージの新しいバージョンを Hackage にアップロードした後、パッケージにオンライン ドキュメントがないため、ドキュメントの自動構築に時間がかかる場合があります。そのようなドキュメントが作成されるまで、パッケージの変更を発表したくありません。

Hackkage ドキュメントのビルド キューを表示する方法、またはドキュメントがビルドされるまでの時間を見積もる別の方法はありますか? または、通知を手配する方法さえありますか？

これは、ドキュメントを手動でアップロードする方法に関する質問ではないことに注意してください。私はそれを行う方法を知っています（そしてしたく​​ありません）。

内部モジュールから値を再エクスポートするモジュールがあるとします。

とSomeTypeとsomeValueで異なるドキュメントを示したいと思います。前者はパブリック API について議論し、後者は残りの内部構造との関係について議論できます。My-Cool-Module.htmlMy-Cool-Module-Internal.html

ハドックでこれを行う方法はありますか？

私は試した：

しかし、ハドックは私に解析エラーを与えました:

カバル プロジェクトの場合、ソース コードへのハイパーリンクを含むハドック ドキュメントを生成したかったので、通常どおりに実行しました。

リンクは生成されましたが、リンクをクリックすると、実際のソース コードは含まれていません。ソース コードは、HTML 経由でレンダリングされることになっています。それらもどのように生成しますか？

現在使用中:

• カバル 1.22.4.0
• cabal-install 1.22.6.0
• ハドック2.16.1