GitHub

Release notes

フォーマットは Keep a Changelog に基づいており、このプロジェクトは Semantic Versioning に従っています。

Unreleased

Changed

  • 現在、フィルターを選択した後もカーソルが検索ボックスにフォーカスしたままです。 (#2410)

Version v1.9.0 - 2025-03-17

Added

  • @meta ブロックで ShareDefaultModule = true を設定すると、すべての名前のない @example、@repl、および @setup ブロックが同じサンドボックスモジュールを共有するようになり、チュートリアルスタイルのドキュメントを書くのがより実用的になります。 (#2656)
  • makedocs と doctest は現在、 doctestfilters において正規表現/置換ペアを受け入れます。 (#2360, #2619)
  • Doctests では、setup コードに加えて teardown コードを持つことができるようになりました。(#2058, #2566, #2577)
  • 検索UIは再びクエリをサイトのURLに入れ、検索へのディープリンクを共有できるようにします。 (#2543, #2646)

Changed

  • シンボリックリンクは、ドキュメントディレクトリを歩く際にフォローされるようになりました。 (#2610)

  • PDF/LaTeXビルドは、sitenameが提供されていない場合に、より情報量の多いエラーをスローするようになりました。(#2636)

  • @autodocs はデフォルトで公開されていないシンボルをリストします（すなわち、Public = true の場合）。 (#2629)

    これは潜在的に破壊的であり、厳密モードで実行されている場合、以前は正常に動作していたビルドが失敗する原因となる可能性があります。publicとしてマークされた未エクスポートのシンボルがあり、それらのドキュメント文字列が手動で@docsブロックなどで含まれている場合、エラーが発生する可能性があります。また、すべての公開シンボルのドキュメント文字列を含む@autodocsブロックもあります。解決策は、重複した含め方を削除することです。

  • checkdocsには、新しいオプション:publicが追加され、publicでマークされた未エクスポートのシンボルがドキュメントに含まれていることを確認します。(#2629)

  • [...]を使用してエラーメッセージの一部（スタックトレースなど）を隠すドクトテストを修正する際、出力がそれ以外は一致する場合、もはや[...]を置き換えません（#2511、#2642)

  • doctest修正によって印刷される警告は、問題のあるコードをより明確に特定するために、現在は少し冗長になっています。 (#2602)

Fixed

  • HTML出力のパンくずリストは、もはや余分なスクロールバーを表示しません。(#2648, #2652)
  • シンタックスハイライトのプリレンダリングは、現在Windowsで正しく機能します。 (#2649)
  • 折りたたまれたドキュメント文字列へのディープリンクは、現在、そのURLに移動するとターゲットのドキュメント文字列が画面の中央に表示されるように正しく機能します。 (#2485, #2651)

Version v1.8.1 - 2025-02-11

Fixed

  • DocMetaは、Julia 1.12で導入されたバインディングのワールドエイジセマンティクスを尊重するように更新されました。(#2621, #2622, #2624)

Version v1.8.0 - 2024-11-07

Changed

  • deploydocs は、すべてのグローバル GPG 署名 Git 設定（つまり、commit.gpgSign = false）を無視します。 (#2592)

Fixed

  • 検索モーダルはもはや検索インデックスの読み込みと競合状態に陥ることがなく、一貫して正しく開くようになりました。 (#2593)

Other

  • Documenterは現在、Runic.jlをコードフォーマットに使用しています。

Version v1.7.0 - 2024-09-04

Added

  • linkcheck HTTP(S) リクエストで設定される User-Agent ヘッダーは、makedocs の linkcheck_useragent オプションでカスタマイズできるようになりました。 (#2557, #2562, #2571)
  • todo カテゴリの注意喚起は現在紫色に色付けされています。以前は、他の未知の注意喚起カテゴリと同様にデフォルトの色でした。 (#2526)
  • makedocs(...) に checkdocs_ignored_modules キーワード引数を追加しました。これにより、特定のモジュールにおけるドキュメントの欠如について checkdocs が警告を出さないようにできます。 (#2233)

Changed

  • デフォルトの User-Agent ヘッダーがリンクチェックの HTTP(S) リクエストで Chrome/51.0.2704.103 の代わりに Chrome/127.0.0.0 を報告するようになりました。これはサーバーがリンクチェックリクエストを解釈する方法を変更し、以前は合格していたチェックが失敗する原因となる可能性がありますが、以前の誤った失敗を修正する可能性が高いです。(#2557, #2569)

Fixed

  • Documenter.HTMLのsize_threshold_ignoreオプションのパスは、現在正しく正規化されており、プラットフォーム依存のパスセパレーターの違いに敏感ではなくなりました。(#2560, #2561)

Version v1.6.0 - 2024-08-20

Changed

  • MathJax3のセットアップは現在tex-svg-full.jsを使用し、デフォルトでmhchemを追加で読み込むことで、化学記号をレンダリングできるようになっています（Pluto.jlと一貫性があります）。(#2549)

Fixed

  • HTML出力におけるドキュメント文字列の折りたたみは、アイコンまたは空の領域をクリックしたときのみトリガーされるようになりました。 (#2204, #2551)

Version v1.5.0 - 2024-06-26

Added

  • 四つの新しい実験的テーマ（catppuccin-latte、catppuccin-frappe、catppuccin-macchiato、およびcatppuccin-mocha）が追加されました。これらはCatppuccinカラーパレットに基づいています。既存のテーマ（documenter-lightとdocumenter-dark）は、それぞれデフォルトのライトテーマとダークテーマのままです。(#2496)

Changed

  • 注意喚起の色合いは、少し目立たなくするためにトーンダウンされました。 (#2499)
  • ドキュメント文字列とコードブロックの厚さと丸みが、注意書きに合わせて調整されました。 (#2499)
  • すべての検索用語は、HTML検索で結果と一致する必要があります。つまり、いずれかではなく、現在はANDで結合されています。(#2514)

Fixed

  • HTML出力の検索プロンプトは、以前は検索がクラッシュする原因となっていた括弧やその他の特殊文字を再び正しく処理します。(#2513)

Version v1.4.1 - 2024-05-02

Fixed

  • HTML出力では、インラインコード内のリンクがホバー時に正しく色付けされるようになりました。(#2497)
  • Doctest修正機能は別のエッジケースを処理します。(#2303, #2378)

Version v1.4.0 - 2024-04-14

Changed

  • 完全修飾された @ref リンクは、CurrentModule に加えて Main でも解決されるようになりました。ドキュメントに含まれるドキュメント文字列を持つパッケージについては、そのパッケージが make.jl でロードされている限り、パッケージ内のドキュメント文字列への完全修飾 @ref リンクはどこからでも機能します。これにより、サブモジュールを使用するパッケージ間のドキュメント文字列のリンクが簡素化されます。 (#2470)
  • HTMLWriter はいくつかのリファクタリングを行いましたが、これはユーザーに見える変更を引き起こすことはないはずですが、Documenter's 内部に依存しているプラグインに影響を与える可能性があります。 (#2475, #2480, #2482)

Version v1.3.0 - 2024-03-01

Added

  • 各ページの @meta ブロックに CollapsedDocStrings キーのサポートを追加しました。特定のページに対して CollapsedDocStrings = true を設定すると、そのページが読み込まれた後にナビゲーションバーの「すべてのドキュメント文字列を折りたたむ」をクリックすることと同じ効果があり、そのページのすべてのドキュメント文字列が折りたたまれます。これにより、API ドキュメントページがより読みやすくなります。 (#2282, #2394, #2459, #2460)
  • 自動的に objects.inv インベントリファイルを作成し、ドキュメントのオンラインデプロイメントに含めるようにします。 DocumenterInterLinks plugin を利用することで、Documenterを使用している他のプロジェクトや Sphinx は、ドキュメント内の任意のページ、見出し、またはドックストリングに外部リンクを作成できます。 (#2366, #2424)
  • makedocsに渡すことができるHTML()オプションにinventory_versionパラメータを追加しました。このオプションは、新しいobjects.invインベントリファイルのversionメタデータフィールドを設定します。ほとんどの場合、インベントリのプロジェクトバージョンは、デプロイ時にdeploydocsからリリースのgitタグに基づいて、メインのProject.tomlファイルから自動的に検出されます。ただし、プロジェクトによっては、例えばpkgversion(MyProject)のように、明示的にinventory_versionを設定したい場合もあります。非標準のセットアップ（ドキュメント専用リポジトリ、モノレポ）を持つプロジェクトは、既存の設定を変更してinventory_versionを明示的に設定する必要があります。（#2449）

Changed

  • HTML出力の検索:
    • 現在は大文字と小文字を区別しません。(#2373, #2374)
    • プレフィックス一致を優先します。 (#2203, #2375)
    • ウェブワーカーを利用し、より応答性が高いです。 (#2415)
    • 検索クエリをクリアしても、フィルターが選択解除されなくなりました。 (#2415)
    • フィルターを選択すると、他のすべてのフィルターが自動的に選択解除されます。 (#2415)

Fixed

  • 特殊なHTMLエンティティのエスケープを修正します。(#2441, #2461)
  • 検索フィルターのトグルボタンのスタイリングをHTML出力で修正します。(#2406, #2408)
  • HTML出力のテーマセレクターは、ユーザーが明示的にテーマを設定していない場合に正しくAutomatic (OS)を選択します。(#2414, #2438)
  • 検索ウィンドウがHTML出力に表示されないことを修正します。(#2430, #2458)

Version v1.2.1 - 2023-12-02

Fixed

  • @meta ブロックの CurrentModule 引数に関する誤った警告を修正します。 (#2364, #2365)

Version v1.2.0 - 2023-11-29

Changed

  • id アンカーは、数値の数字で始めることができるようになりました。 (#744, #2325)
  • Documenterは、Markdown内に予期しないJuliaの補間がある場合（例えば、誤った$記号から）に、より情報量の多い警告を表示します。(#2288, #2327)
  • Documenterは、さまざまなキーと値のat-blockで無効なキーに遭遇したときに警告を出すようになりました。(#2306, #2324)
  • ファイルサイズは現在、より人間に読みやすい形式で表現されています。(#2272, #2344)
  • Documenterは、Git操作のためにシステムのgitバイナリの代わりにGit.jlを使用します。(#2348)
  • Woodpecker CI 1.x と 2.x もサポートされるようになりました。 (#2337, #2335, #2339)

Fixed

  • 小さい画面でドキュメント文字列のヘッダーのテキストラッピングを有効にしました。 (#2293, #2307)
  • 狭い画面（モバイル）での長いページタイトルによるパンくずリストのオーバーフローを修正しました。 (#2317)
  • linkcheckがドキュメント文字列内をチェックしない問題を修正しました。(#2329, #2330)
  • ヘッディングは、ドキュメント文字列内のリストで <strong> に書き換えられました。(#2308, #2313)

Version v1.1.2 - 2023-10-23

Fixed

  • ノンブレイキングスペースは、LaTeXWriterで正しく"~"に変換されるようになりました。(#2300)

Version v1.1.1 - 2023-10-12

Fixed

  • 修正済み、ドキュメント文字列の折りたたみ/展開アイコンが迅速にクリックしたときに正しく変更されない問題。 (#2103, #2217)

Version v1.1.0 - 2023-09-28

Added

  • Remotes.GitLabを追加して、gitlab.com上または自己ホスト型GitLabインスタンスにホストされたRemoteを指定できるようにしました。(#2279)

Fixed

  • インラインLaTeX数式の表示を修正しました $ ... $ show メソッドのHTMLWriterで。(#2280, #2281)
  • GitHubリモートリンクチェックでremotes = nothingのときにクラッシュを修正しました。(#2274, #2285)
  • DocTestFilters = nothingを@metaブロックで発生するエラーを修正します。(#2273, #1696)

Version v1.0.1 - 2023-09-18

Fixed

  • ドキュメント文字列は、Markdown.@doc_str マクロを使用して作成されたような、アンラップされた Markdown.MD オブジェクトを正しく処理します。 (#2269)

Version v1.0.0 - 2023-09-15

Version changes

  • 必要なJuliaのバージョンが1.0から1.6に引き上げられました。古いJuliaバージョンでは、0.27.Xリリースを引き続き使用できます。(#1835, #1841)

Breaking

  • makedocsへのstrictキーワード引数は削除され、warnonlyに置き換えられました。makedocsは現在、ドキュメントチェックのいずれかが失敗した場合にデフォルトでビルドを失敗させます（以前はデフォルトで警告のみを発していました）。(#2051, #2194)

    アップグレードのために: strict = trueで実行している場合は、strictオプションを削除するだけで済みます。特定のエラークラスについて厳密にしている場合は、Documenter.exceptを使用してエラークラスのリストを反転させることができます。

    strict キーワードを設定していなかった場合、しかしビルドが失敗している場合は、まずビルドの失敗を引き起こしているエラーを修正するよう努めるべきです。それが不可能な場合は、特定のエラーカテゴリをビルドの失敗から除外することができます（例： warnonly = [:footnote, :cross_references]）。最後に、 warnonly = true を設定することで、古い strict = false のデフォルト動作を回復し、すべてのエラーを警告に戻すことができます。

  • MarkdownバックエンドはDocumenterパッケージから完全に削除され、外部の DocumenterMarkdown package に置き換えられました。これには、エクスポートされた Deps モジュールの削除が含まれます。(#1826)

    アップグレードのために: Markdown バックエンドを引き続き使用するには、DocumenterMarkdown package を参照してください。ただし、そのパッケージは最新の Documenter バージョンをすぐにはサポートしない可能性があります。

  • @eval ブロックは、最後の式が nothing または Markdown.MD 型である必要があり、他のケースでは :eval_block エラーが発生し、オブジェクトのテキスト表現にフォールバックします。 (#1919, #2260)

    アップグレードのために: @eval の結果が nothing または ::Markdown.MD でないオブジェクトの場合、返されたオブジェクトを確認する必要があります。結果のオブジェクトが何らかの Markdown ノードタイプ（例: Markdown.Paragraph または Markdown.Table）である場合、ブロックノードの場合は単に Markdown.MD([...]) でラップすることができ、インラインノードの場合は Markdown.MD([Markdown.Paragraph([...])]) でラップできます。他のケースでは、Documenter が返されたオブジェクトを正しく処理していなかった可能性がありますが、この変更が以前に動作していた使用ケースを壊した場合は、問題をオープンしてください。エラーは :eval_block を warnonly キーワードに渡すことで無視できます。

  • リモートリポジトリ（例：GitHub）URLの取り扱いが見直されました。 (#1808, #1881, #2081, #2232)

    メインリポジトリのソースおよび編集リンクを生成することに加えて、Documenterは、異なるリポジトリからのファイルがある場合（例：ベンダー依存関係を持つ場合）に正しいリンクを生成するように設定できるようになりました。また、ソースおよび編集リンクの自動検出の動作に関する変更や修正も行われました。

    TRAVIS_REPO_SLUG および GITHUB_REPOSITORY 変数へのフォールバックは、makedocs 呼び出しで repo キーワードを明示的に指定することを優先するために削除されました。

    Documenterは、URLを特定できない場合に関してもより厳格になりました。そのため、以前は成功していたビルドが失敗する可能性があります。

    アップグレードのために: CI変数へのフォールバックが削除されたため、ドキュメントをビルドする際には、ソースが適切なGitリポジトリとしてチェックアウトされていることを確認してください。そうすることで、DocumenterはGitのorigin URLからリポジトリリンクを自動的に判断できます。GitHub Actionsでは、通常これが既に当てはまるため、ユーザーの操作は必要ないでしょう。他の場合、必要に応じて、makedocsのrepoおよび/またはremotesキーワードを適切に設定できます。

    これらの変更は、主にドキュメント文字列やさまざまなソースからのファイルを含む複雑なビルドに影響を与えるべきです。特に後者の場合、関連するすべてのパッケージが完全にクローンされ、docs/Project.toml（または同等の）環境に開発依存関係として追加されていることを確認する必要があります（または、Pkg.addされたパッケージに対してremotesキーワードが設定されていること）。

    最後に、一般的に、ビルドが成功した場合でも、さまざまなリモートリンク（リポジトリリンク、ソースリンク、編集リンク）が正しく生成されていることを再確認してください。予期しないエラーが発生した場合は、問題をオープンしてください。

  • Documenterは、ローカルリンク（他のMarkdownファイルやローカル画像へのリンク、例えば[see the other page](other.md)）が存在するファイルを指しているかどうかをチェックします。(#2130, #2187)

    これにより、以前の壊れたリンクが現在Documenterのドキュメントチェックによって検出されるため、既存のビルドが失敗する可能性があります。特に、Documenterはデフォルトで厳密モードで実行されるようになったためです。

    アップグレードのために: すべての問題のあるリンクを再確認し、修正する必要があります。あるいは、warnonly = :cross_referencesを設定することもできますが、その場合、エラーは警告に減少します（ただし、これは推奨されません。生成されたドキュメントに壊れたリンクが含まれるためです）。

  • HTML出力は、生成されたHTMLファイルのサイズしきい値を強制するようになりました。これは、Documenterが非常に大きなHTMLファイル（通常は図などの生成されたコンテンツによる）をデプロイするケースをキャッチするためです。生成されたHTMLファイルがいずれかのしきい値を超える場合、Documenterはエラーを出してビルドを失敗させるか（size_thresholdを超えた場合）、警告を出します（size_threshold_warnを超えた場合）。特定のページについては、size_threshold_ignoreを使用してサイズしきい値を無視することもできます。(#2142, #2205, #2211, #2252)

    アップグレードのために: ビルドがサイズ閾値チェックのために失敗している場合、まず生成されたHTMLファイルがなぜそんなに大きいのかを調査する必要があります（例えば、非常に大きなインラインSVG図形のように、過剰にHTMLを自動生成している可能性があります）そして、それらをデフォルトの閾値以下に減らすように努めてください。生成されたファイルサイズを減らすことができない場合は、size_thresholdの値を最大サイズを少し上回るように増やすか、size_threshold = nothingを設定してサイズ閾値チェックの強制を完全に無効にすることができます。もし問題があるのが特定のページだけであれば、size_threshold_ignoreを使ってそれらを無視することもできます。

  • ユーザー提供の assets/search.js ファイルはもはやDocumenterのデフォルトの検索実装をオーバーライドせず、ユーザー提供のファイルはデフォルトで無視されるようになります。 (#2236)

    アップグレードのために: JSファイルは、format = HTML(...)のassetsキーワードを介してまだ含めることができます。しかし、これはDocumenterのデフォルトの検索実装と競合する可能性があります。Documenterの検索エンジンをオーバーライドするAPIが必要な場合は、問題をオープンしてください。

  • プラグインオブジェクトは、以前はmakedocsに（文書化されていない）位置引数として渡されていましたが、現在はキーワード引数として渡されるリストpluginsの要素として与えられています（#2245、#2249）

    アップグレードのために: makedocsにプラグインオブジェクトを渡す場合（位置的に）、代わりにpluginsキーワードを介して渡してください。

  • makedocsは、サポートされていないキーワード引数が渡された場合にエラーをスローするようになります。 (#2259)

    アップグレードのために: makedocs 呼び出しからリストされたキーワード引数を削除してください。キーワードが以前は有効であった場合は、このCHANGELOGを参照してアップグレード手順を確認してください。

Added

  • Doctest フィルターは、置換を制御するために正規表現/置換ペアとして指定できるようになりました。すなわち、r"..." => s"..." の形式です（デフォルトは空文字列 "" です）。(#1989, #1271)

  • Documenterは、必要ないときに環境からDOCUMENTER_KEYを削除することで、SSHキーが誤って漏洩するのをより注意深く防ぐようになりました。（#1958、#1962）

  • LaTeX出力では、注意喚起が色付きでスタイルされています。 (#1931, #1932, #1946, #1955)

  • LaTeXWriterのコードブロックのスタイリングを改善しました。(#1933, #1935, #1936, #1944, #1956, #1957)

  • 自動的に LaTeXWriter の @example ブロック内のオーバーサイズ tabular 環境をリサイズします。(#1930, #1937)

  • HTML()のansicolorキーワードは現在デフォルトでtrueになっており、@exampleおよび@replブロックからの実行された出力はデフォルトで色付けされます（色付き出力を生成する場合）。(#1828)

  • Documenterは、ナビゲーションバーの上部にリポジトリのルートへのリンクを表示します。このリンクは、リモートリポジトリから自動的に決定されますが、HTMLのrepolink引数を使用して上書きするか無効にすることができます。 (#1254)

  • より一般的なAPIが利用可能になり、makedocsのrepo引数を介してリモートリポジトリのURLを設定することができます。これは、Remotes.Remoteのサブタイプであり、そのインターフェースを実装するオブジェクト（例：Remotes.GitHub）を渡すことによって実現されます。(#1808, #1881)

  • 壊れた問題参照（つまり、[#1234](@ref)のようなリンクですが、DocumenterがリモートGitHubリポジトリを特定できない場合）は、strictキーワードを介してキャッチできる:cross_referencesエラーを生成します。(#1808)

    これは潜在的に壊れる可能性があり、厳密モードで実行されている場合、以前は正常に動作していたビルドが失敗する原因となる可能性があります。しかし、そのようなビルドはすでに生成されたドキュメントに壊れたリンクを残していました。

    アップグレードのために: ビルドを修正する最も簡単な方法は、問題のある @ref リンクを削除することです。あるいは、makedocs の repo 引数を、正しい URL が生成されることを保証する Remotes.issueurl 関数を実装した適切な Remotes.Remote オブジェクトに設定することができます。

  • Woodpecker CIは、ドキュメントのデプロイメントを自動的にサポートするようになりました。(#1880)

  • @contentsブロックは、Depth引数に対してUnitRangeをサポートするようになりました。これにより、表示されるべき最小ヘッダー深度を設定することが可能になります（例えば、Depth = 2:3）。これはHTMLおよびLaTeX/PDFバックエンドでサポートされています。(#245, #1890)

  • HTMLのコードコピーボタンには、現在titleおよびaria-label属性があります。 (#1903)

  • at-refリンクはより柔軟になり、任意のリンクがドキュメント文字列とセクション見出しの両方を指すことができるようになりました。(23373831_68747470733a2f2f6769746875622e636f2e636f6d2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f373831, 2331393030_68747470733a2f2f6769746875622e636f2e636f6d2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f31393030)

  • コードブロック @example や @repl は、現在、ネストされたコンテキスト（例：注意書き、リスト、またはブロック引用）でも展開されるようになりました。 (#491, #1970)

  • 新しい pagesonly キーワードを makedocs に使用すると、pages にリストされたMarkdownファイルのみにビルドを制限できます（src/ のすべての .md ファイルではなく）。 (#1980)

  • 検索エンジンとソーシャルメディアのリンクプレビューがサポートされるようになり、Documenterが関連するHTML meta タグを生成します。 (#1321, #1991)

  • deploydocs はカスタムタグプレフィックスをサポートするようになりました。詳細はドキュメントの「モノレポからのデプロイ」セクションを参照してください。 (#1291, #1792, #1993)

  • deploydocsのtargetキーワードは、現在rootのサブディレクトリを指す必要があります（通常はmake.jlがあるディレクトリです）。(#2019)

  • 検索ボックスのキーボードショートカットを追加しました（Ctrl + / または Cmd + / で検索ボックスにフォーカス、Esc でフォーカスを外します）。 (#1536, #2027)

  • HTMLバックエンドのさまざまなJSおよびフォント依存関係が最新の非破壊バージョンに更新されました。(#2066, #2067, #2070, #2071, #2213)

    • KaTeXはv0.13.24からv0.16.8に更新されました（メジャーバージョンのアップグレード）。
    • Font Awesomeはv5.15.4からv6.4.2に更新されました（メジャーバージョンのアップ）。
    • bulma.sassはv0.7.5からv0.9.4に更新されました（メジャーバージョンのアップグレード）。
    • darkly.scssがv0.8.1に更新されました。
    • highlight.jsはv11.5.1からv11.8.0に更新されました。
    • JuliaMonoはv0.045からv0.050に更新されました。
    • jQuery UIはv1.12.1からv1.13.2に更新されました。
    • jqueryはv3.6.0からv3.7.0に更新されました。
    • MathJax 2はv2.7.7からv2.7.9に更新されました。

  • モバイルレイアウトのサイドバーのトグル（ハンバーガー）を右側から左側に移動します。(#1312, #2076, #2169, #2215, #2216)

  • 個別およびすべてのドキュメント文字列を展開/折りたたむ機能を追加しました。(#1393, #2078)

  • HTMLレンダリング中の無効なローカルリンク警告は、問題のあるリンクを特定するのに役立つもう少しコンテキストを印刷するようになりました。 (#2100)

  • details カテゴリの注意書きは、HTML バックエンドで (折りたたまれた) <details> としてレンダリングされるようになりました。注意書きのタイトルは <summary> として使用されます。 (#2128)

  • テーマスイッチャーには、ユーザーのOS設定に従う「自動（OSの設定）」オプションが含まれるようになりました。(#1745, #2085, #2170)

  • Documenterは、ビルドに関するいくつかのメタデータを含む.documenter-siteinfo.jsonファイルをHTMLビルドに生成します。(#2181)

  • 検索UIは完全に刷新され、検索結果に対するより良いコンテキストを持つ新しいモーダルUIと、不要な結果を除去するためのフィルターメカニズムが導入されました。クライアントサイドの検索エンジンはLunrJsからMinisearchJsに変更されました。 (#1437, #2141, #2147, #2202)

  • doctestルーチンは、makedocsと同じpluginsキーワード引数を受け取ることができるようになりました。これにより、必須のPluginオブジェクトを持つプラグインがロードされている場合にdoctestを実行できるようになります。例えば、DocumenterCitationsや#2245です。

  • HTML出力は、自動的に大きな@exampleブロックの出力をファイルに書き込み、生成されたHTMLファイルを小さくします。サイズの閾値は、HTMLのexample_size_thresholdオプションで制御できます。(#2143, #2247)

  • @docs と @autodocs ブロックは、非標準として宣言できるようになり、同じドキュメント文字列の複数のコピーをマニュアルに含めることができます。 (#1079, #1570, #2237)

Fixed

  • Markdownソースファイルの行末は、解析前にLFに正規化されるようになりました。これは、行末に敏感な解析を行うJulia Markdownパーサーの[bバグ][JuliaLang/julia#29344]を回避するためであり、そのためプラットフォーム依存の動作を引き起こす可能性があります。(#1906)

  • HTMLWriter は、makedocs が Julia セッション内で複数回実行される際に、ドキュメント文字列内の無効な URL に対してももはや不満を言わなくなりました。これは、基盤となるドキュメント文字列オブジェクトを変更しなくなったためです。(#505, #1924)

  • Docstring doctestsは、同じJuliaセッション内で複数回実行されるときに、各makedocs実行時に適切にチェックされるようになりました。(#974, #1948)

  • プルリクエストのプレビュービルドをデプロイするかどうかのデフォルトの決定が、プルリクエストの出所を確認できない場合に true から false に変更されました。 (#1969)

  • deploydocs は、宛先ディレクトリが削除された場合でも、バージョンのシンボリックリンクを正しく処理します。 (#2012)

Other

  • Documenterは現在、Markdownドキュメントを内部的にMarkdownASTを使用して表現しています。この変更はユーザーに目に見える変化をもたらすべきではありませんが、コードの大規模なリファクタリングです。バージョン0.28にアップグレードする際に遭遇した新しいエラーや予期しない動作について報告してください。Documenter issue tracker。(#1892, #1912, #1924, #1948)

  • コードのレイアウトが大幅に変更され、多くの内部サブモジュールが削除されました。これは、さまざまなDocumenterの内部にフックしているコードにとって壊れる可能性があります。さまざまな型や関数が異なるコードパスに存在するようになりました。(#1976, #1977, #2191, #2214)

Version v0.27.25 - 2023-07-03

Fixed

  • ページ見出しは、LaTeXWriterで正しくエスケープされるようになりました。(#2134)

  • Sassを使用してダークテーマをコンパイルすると、!globalの割り当てに関する非推奨警告がもはや出力されません。(#1766, #1983, #2145)

  • CSSドキュメンターは現在ミニファイドされています。(#2153, #2157)

Version v0.27.24 - 2023-01-23

Security

  • deploydocs は、一時的なSSHキーファイルをGitリポジトリにコミットしないように、より注意を払うようになりました。 (#2018)

Version v0.27.23 - 2022-08-26

Added

  • native と docker の PDF ビルドは、LaTeX エラーログをより読みやすくし、ビルドを早期に失敗させるために、-interaction=batchmode（nonstopmode の代わりに）および -halt-on-error オプションで実行されるようになりました。 (2331393038_68747470733a2f2f6769746875622e636f2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f31393038)

Fixed

  • PDF/LaTeX出力は、ハードMarkdown改行（すなわち、Markdown.LineBreakノード）を処理できるようになりました。(#1908)

  • 以前はPDF出力内の壊れたリンクが修正されました。(JuliaLang/julia#38054, JuliaLang/julia#43652, #1909)

Version v0.27.22 - 2022-07-24

Other

  • Documenterは現在、DocStringExtensions v0.9と互換性があります。(#1885, #1886)

Version v0.27.21 - 2022-07-13

Fixed

  • Gitが利用できないシステムでDocumenterがエラーをスローする回帰を修正しました。 (#1870, #1871)

Version v0.27.20 - 2022-07-10

Added

  • HTMLバックエンドのさまざまなJSおよびフォント依存関係が最新の非破壊バージョンに更新されました。 (#1844, #1846)

    • MathJax 3はv3.2.0からv3.2.2に更新されました。
    • JuliaMonoはv0.044からv0.045に更新されました。
    • Font Awesomeはv5.15.3からv5.15.4に更新されました。
    • highlight.jsはv11.0.1からv11.5.1に更新されました。
    • KaTeXはv0.13.11からv0.13.24に更新されました。

  • 実験的: deploydocs は、未文書の実験的な archive キーワードを介して「tarball へのデプロイ」をサポートするようになりました（gh-pages ブランチへのプッシュではなく）。(#1865)

Fixed

  • エイリアスのためのドキュメント文字列を含める際、Documenterはまず署名のサブタイプをチェックする前に、正確に一致するドキュメント文字列を含めようとするようになりました。 (#1842)

  • ドキュメントが不足しているかどうかを確認する際、Documenterは現在、現在のモジュールにインポートされていない他のモジュールからのバインディングを拡張するメソッドのドキュメント文字列を正しく処理します。(#1695, #1857, #1861)

  • GIT_TEMPLATE_DIRをオーバーライドすることで、gitはDocumenterによって内部的に呼び出されたときに任意のユーザーテンプレートやフックを取得しなくなります。(#1862)

Version v0.27.19 - 2022-06-05

Added

  • Documenterは、makedocsにdraft=trueを渡すことでHTMLドキュメントのドラフト版をビルドできるようになりました。ドラフトモードは、ビルドプロセスの潜在的に高コストな部分をスキップし、ドキュメント作成時に迅速なフィードバックを得るのに役立ちます。ドラフトモードは現在、doctests、@example、@repl、@eval、および@setupブロックをスキップします。ドラフトモードは、@metaブロック内でDraft = trueを設定することにより、ページごとに無効化（または有効化）できます。(#1836)

  • HTML検索ページでは、Enterキーを押してもページがリフレッシュされなくなりました（そのため、遅い検索インデックスの再構築がトリガーされません）。 (#1728, #1833, #1834)

  • HTML()のedit_linkキーワードに対して、Documenterはリモートのデフォルトブランチがmain、master、または他の何かであるかを自動的に判断しようとします。edit_linkまたはdevbranch（deploydocs用）を信頼性高く特定できない場合は、警告を表示します。(#1827, #1829)

  • プロファイリングの結果、HTMLページのビルド時間の大部分が外部のgitコマンド（ドキュメント文字列のリモートURLを見つけるために使用）に起因していることが示されました。これらの結果はソースファイルごとにキャッシュされるようになり、ビルド時間が短縮されました。これは、ドキュメントを執筆中にライブ更新するためのLiveServer.jlの機能を使用する際に特に便利です。(#1838)

Version v0.27.18 - 2022-05-25

Added

  • HTMLスタイルのさまざまなコンテナ要素のパディングが減少し、生成されたHTMLページの見た目が改善されました。 (#1814, #1818)

Fixed

  • 未バージョンのドキュメントをデプロイする際、Documenterはバージョンセレクタを無効にするsiteinfo.jsファイルを生成します。これは、../versions.jsが存在する場合でも同様です。(#1667, #1825)

  • ビルドの失敗は、すべてのエラーではなく、致命的なエラーのみを表示します。 (#1816)

  • リモートHEADブランチを検出する際にSSHリモート用のgitターミナルプロンプトを無効にし、ENVを上書きするのではなく追加することでssh-agent認証を許可します。 (#1821)

Version v0.27.17 - 2022-05-09

Added

  • PDF/LaTeX出力は、Tectonic LaTeXエンジンでコンパイルできるようになりました。(#1802, 2331383033_68747470733a2f2f6769746875622e636f6d2f4a756c6961446f63732f446f63756e7465722e6a6c2f6973737565732f31383033)

  • HTML出力の古いバージョン警告の表現が改善されました。 (#1805)

  • Documenterは現在、makedocsにstrictキーワードを介して渡されるエラーのリストを「反転」するために使用できるDocumenter.except関数を提供しています。(#1811)

Fixed

  • HTTPおよびHTTPS URLのリンクチェックを行う際、Documenterはリクエストとともに現実的なaccept-encodingヘッダーも送信するようになりました。これは、非ブラウザリクエストをブロックしようとするサーバーを回避するためです。(#1807)

  • LaTeXビルドログは、Dockerビルドオプションを使用する際に、LaTeXWriter.{stdout,stderr}ファイルに正しく出力されるようになりました。(#1806)

  • makedocs は、呼び出し構文に関連付けられたドキュメント文字列に関する特定の種類の悪いドキュメントシステム状態に遭遇した場合に UndefVarError で失敗することはなくなりましたが、代わりに @autodocs エラー/警告を発行します。 (JuliaLang/julia#45174, #1192, #1810, #1811)

Version v0.27.16 - 2022-04-19

Added

  • CSSソースファイルを更新して、すべてのフォントバリエーションが含まれるようにし（JuliaMono Regularだけでなく）、フォントの最新バージョン（0.039から0.044）を使用するようにします。(#1780, #1784)

  • 生成されたPDFの目次では、セクション番号とタイトルの間により多くのスペースがあり、重ならないようになっています。 (#1785)

  • PDFビルドのLaTeXソースの前文は、ユーザーによってカスタマイズできるようになりました。 (#1746, #1788)

  • PDFマニュアルに表示されるパッケージのバージョン番号は、format = LaTeX()にversionオプションを渡すことでユーザーが設定できるようになりました。(#1795)

Fixed

  • strictモードを修正して、警告だけでなくエラーも正しく表示するようにします。 (#1756, #1776)

  • リモートHEADブランチを検出する際にgitターミナルプロンプトを無効にします。 (#1797)

  • HTTPおよびHTTPS URLのリンクチェックを行う際、Documenterはリクエストと共に現実的なブラウザ（Chrome）のUser-Agentヘッダーを送信するようになりました。これは、User-Agentを使用して非ブラウザリクエストをブロックしようとするサーバーを回避するためです。(#1796)

Version v0.27.15 - 2022-03-17

Added

  • Documenterは、スケジュールされたジョブ（GitHub Actionsのschedule）からドキュメントをデプロイします。(#1772, #1773)

  • テーブルオブコンテンツセクションのレイアウトを改善します。 (#1750)

Fixed

  • REPLブロック内の余分な空白を修正する改善を行います。 (#1774)

Version v0.27.14 - 2022-03-02

Fixed

  • CSSバグを修正して、REPLコードブロックに余分な空白が含まれないようにします。 (#1770, #1771)

Version v0.27.13 - 2022-02-25

Fixed

  • CSSバグを修正して、コードコピーボタンの位置が右上隅に固定されるようにします。(#1758, #1759)

  • copy.js スクリプトを読み込む際のバグを修正します。 (#1760, #1762)

Version v0.27.12 - 2022-01-17

Fixed

  • コードコピーボタンを安全でないコンテキスト（例：HTTPSなしでホストされたページ）で修正します。 (#1754)

Version v0.27.11 - 2022-01-16

Added

  • Documenterは、手動でトリガーされたイベント（GitHub Actionsのworkflow_dispatch）からドキュメントをデプロイします。(#1554, #1752)

  • MathJax 3はv3.2.0に更新されました（マイナーバージョンのアップ）。 (#1743)

  • HTML コードブロックには、コピー ボタンが追加されました。 (#1748)

  • Documenterは、古いデフォルト（master）をフォールバックとして使用して、gitを使って開発ブランチを検出しようとします。開発ブランチとしてmainを使用している場合、もうdevbranch = "main"をdeploydocsの引数として指定する必要はありません。(#1443, #1727, #1751)

Version v0.27.10 - 2021-10-20

Fixed

  • LaTeXWriterのヘッダーの深さを修正します。

Version v0.27.9 - 2021-10-18

Fixed

  • LaTeXWriterのtext/latex MIMEタイプに関するいくつかのエラーを修正します。

Version v0.27.8 - 2021-10-14

Added

  • makedocsのキーワード引数strictはより柔軟です：エラーが失敗を引き起こすべきかどうかを示すブール値に加えて、strictはどのエラーがビルドの失敗を引き起こすべきかを示すSymbolまたはVector{Symbol}も受け入れます。(#1689)

  • ユーザーがカスタムJavaScriptリソースを注入して、plausible.ioのようなGoogle Analyticsの代替を有効にすることを許可します。 (#1706)

Fixed

  • 申し訳ありませんが、そのリクエストにはお応えできません。

Version v0.27.7 - 2021-09-27

Fixed

  • 最初に push_preview でドキュメントをビルドする際のエラーを修正します。 (#1693, #1704)

  • 稀なロガーエラーを修正しました。失敗したドクトテストのために。 (#1698, #1699)

  • @meta ブロック内で DocTestFilters = nothing に関するエラーを修正します。 (#1696)

Version v0.27.6 - 2021-09-07

Added

  • index.htmlを生成してdevまたはstableにリダイレクトするサポートを追加します。リダイレクト先は、古い警告と同じです。ユーザーが生成したindex.htmlがすでに存在する場合、Documenterはファイルを上書きしません。(#937, #1657, #1658)

Fixed

  • PRが正しいリポジトリから来ているかどうかを確認することが、GitHub Actionsでプレビューをデプロイする際に、Julia 1.0でも機能するようになりました。 (#1665)

  • ドクトテストが失敗した場合、ロガーにテストコードの位置ではなく、ドクトテストの位置に関連付けられたファイルと行の情報を渡します。 (#1687)

  • @replブロックの各出力に対してカラープリンティングを有効にしました。 (#1691)

Version v0.27.5 - 2021-07-27

Fixed

  • バージョン v0.27.4 で導入されたエラーを修正しました (PR(#1634)、これは @eval/@repl/@example ブロック内の末尾コメントによって引き起こされました。(#1655、#1661)

Version v0.27.4 - 2021-07-19

Added

  • @example-ブロックおよび @repl-ブロックは、ANSIエスケープシーケンスをHTMLにマッピングすることでカラー出力をサポートするようになりました。これにはJulia >= 1.6が必要で、Documenter.HTMLにansicolor=trueを渡す必要があります（例：makedocs(format=Documenter.HTML(ansicolor=true, ...), ...)）。Documenter 0.28.0ではこれがデフォルトとなるため、（事前に）オプトアウトするにはansicolor=falseを渡してください。(#1441, #1628, #1629, #1647)

  • 実験的 DocumenterのHTML出力は、コードブロックの構文ハイライトを事前レンダリングできるようになりました。つまり、構文ハイライトはHTMLページを生成する際に適用され、ページが読み込まれた後にブラウザで動的に適用されるのではありません。これには、(i) Documenter.HTMLにprerender=trueを渡すことと、(ii) PATHに利用可能なnode（NodeJS）実行可能ファイルが必要です。Documenter.HTMLにnodeキーワード引数を渡すことで、node実行可能ファイルへのパスを指定できます（例えば、NodeJS_16_jll Juliaパッケージから）。さらに、highlightjsキーワード引数を使用してhighlight.jsライブラリへのファイルパスを指定することもできます（これが指定されていない場合、Documenterで使用されるリリースが使用されます）。例の設定:

    using Documenter, NodeJS_16_jll

makedocs(;
    format = Documenter.HTML(
        prerender = true,            # enable prerendering
        node = NodeJS_16_jll.node(), # specify node executable (required if not available in PATH)
        # ...
    )
    # ...
)

    この機能は実験的であり、将来のリリースで変更される可能性があります。 (#1627)

  • julia> プロンプトは、julia-repl 言語ハイライトで緑色になりました。 (#1639, #1641)

  • .hljs CSS クラスは、非ハイライトコードブロックおよび JavaScript が無効な場合に正しいテキストカラーが使用されるように、すべてのコードブロックに追加されました。(#1645)

  • サンドボックスモジュールは、@replおよび@exampleブロックの評価に使用されていましたが、現在はテキスト出力でMainに置き換えられています。(#1633)

  • @repl、@example、および @eval ブロックには LineNumberNodes が挿入されるようになり、例えば @__FILE__ や @__LINE__ がファイルに対して "none" ではなく、行に対して 1 ではなく、より良い出力を提供します。これは Julia 1.6 以上が必要です（以前の Julia バージョンでは変更はありません）。 (#1634)

Fixed

  • HTML出力のドル記号は、ブラウザで数学の区切り記号として誤って解釈されることがなくなりました。 (#890, #1625)

  • 数式環境のオーバーフロー動作を修正して、不必要な垂直スクロールバーを隠します。(#1575, #1649)

Version v0.27.3 - 2021-06-29

Added

  • Documenterは、バージョン付きフォルダーの代わりにドキュメントを「ルート」に直接デプロイできるようになりました。(#1615, #1616)

  • ドキュメントを生成するために使用されるDocumenterのバージョンがビルド情報に表示されるようになりました。 (#1609, #1611)

Fixed

  • HTMLフロントエンドは、コードを表示する際にもはやリガチャを使用しません（JuliaMonoを使用）。 (#1610, #1617)

Version v0.27.2 - 2021-06-18

Added

  • デフォルトフォントは Lato Medium に変更され、テキストの見た目が古いGoogle FontsバージョンのLatoに近くなるようにしました。 (#1602, #1604)

Version v0.27.1 - 2021-06-17

Added

  • HTML出力は現在、CDNJSから取得したデフォルトの等幅フォントとして JuliaMono を使用しています。関連して、LatoフォントもCDNJSから取得されるようになり、生成されたHTMLページはもはやGoogle Fontsに依存しません。(#618, #1561, #1568, #1569)、JuliaLang/www.julialang.org

  • テキストの古いバージョンの警告ボックスの文言が改善されました。 (#1595)

Fixed

  • Documenterは、デプロイされたバージョンがない場合にバージョンセレクタを生成する際にエラーをスローしなくなりました。(#1594, #1596)

Version v0.27.0 - 2021-06-11

Added

  • JSの依存関係がそれぞれの最新バージョンに更新されました。

    • highlight.jsはv11.0.1（メジャーバージョンアップ）に更新され、Juliaコードのハイライトにさまざまな更新が加えられました。highlight.jsの変更により、IE11ではコードのハイライトが機能しません。(#1503, #1551, #1590)

    • Headroom.jsはv0.12.0に更新されました（メジャーバージョンのアップ）。 (#1590)

    • KaTeXがv0.13.11に更新されました（メジャーバージョンのアップ）。 (#1590)

    • MathJaxのバージョンがそれぞれMathJax 2と3のためにv2.7.7（パッチバージョンの増加）およびv3.1.4（マイナーバージョンの増加）に更新されました。(#1590)

    • jQueryはv3.6.0に更新されました（マイナーバージョンのアップ）。 (#1590)

    • Font Awesomeはv5.15.3に更新されました（パッチバージョンのアップ）。 (#1590)

    • lunr.jsはv2.3.9に更新されました（パッチバージョンの増加）。 (#1590)

    • lodash.jsはv4.17.21に更新されました（パッチバージョンのアップ）。 (#1590)

  • deploydocs は、gh-pages にデプロイするために使用される Git の呼び出しで何か問題が発生した場合にエラーをスローします。 (#1529)

  • HTML出力では、サイドバーの上部にあるサイト名もロゴと同様にドキュメントのメインページにリンクされています。 (#1553)

  • 生成されたHTMLサイトは、ユーザーが閲覧しているバージョンがパッケージの最新バージョンでない場合にそれを検出し、最新バージョンへのリンクを含む通知ボックスをユーザーに表示できるようになりました。さらに、ページにはnoindexタグが追加され、古いバージョンを検索エンジンの結果から削除するのに役立つはずです。(#1302, #1449, #1577)

  • HTML出力の分析は現在、古い非推奨のセットアップを置き換えてgtag.jsスクリプトを使用しています。(#1559)

Fixed

  • deploydocs に対する不正な repo 引数がプロトコルを含む場合、誤解されるのではなくエラーがスローされるようになりました。 (#1531, #1533)

  • @example ブロックによって生成された SVG 画像は、SVG タグを HTML に直接埋め込むのではなく、画像を URI エンコードすることによってページ幅に適切にスケーリングされるようになりました。(#1537, #1538)

  • deploydocs はもはや GitHub Actions でフォークからのプルリクエストプレビューをデプロイしようとしません。 (#1534, #1567)

Other

  • DocumenterはもはやIOCapture v0.1と互換性がなく、現在はIOCapture v0.2が必要です。 (#1549)

Version v0.26.3 - 2021-03-02

Fixed

  • 一時モジュールの内部名は、Juliaの今後の印刷変更に対応するために変更されました。 (JuliaLang/julia#39841, #1540)

Version v0.26.2 - 2021-02-15

Added

  • doctest() は、何らかの理由で一時ディレクトリのクリーンアップに失敗しても、もはやエラーをスローしません。 (#1513, #1526)

  • PDF出力の見た目の改善。 (#1342, #1527)

  • jldoctest キーワード引数の解析に失敗した場合、これらは警告で無視されるのではなく、ドキュメンテーションテストの失敗としてログに記録されるようになりました。また、解析に失敗する理由に応じて makedocs がエラーをスローすることもありません。 (#1556, #1557)

Fixed

  • スクリプトタイプのドクトテストで出力セクションが空の場合、Documenterがクラッシュしなくなりました。 (#1510)

  • デプロイ時に認証キーを確認する際、Documenterは環境変数が定義されているかどうかだけでなく、空でないかどうかも適切にチェックするようになりました。 (#1511)

  • Doctestsは、リポジトリがCRLF行末でチェックアウトされた場合（これはWindowsでcore.autocrlf=trueの設定があると発生する可能性があります）を正しく処理するようになりました。(#1516, #1519, #1520)

  • マルチライン方程式は、at-block 出力で正しく処理されるようになりました。 (#1518)

Version v0.26.1 - 2020-12-16

Fixed

  • HTML資産は、Documentersソースからビルド出力に直接コピーされる際に、正しいファイル権限を持つようになりました。(#1497)

Version v0.26.0 - 2020-12-10

Breaking

  • PDF/LaTeX出力は再びDocumenterの組み込み機能として提供されており、formatにDocumenter.LaTeXのインスタンスを渡すことで有効にできます。DocumenterLaTeXパッケージは非推奨となりました。(#1493)

    アップグレードのために: PDF/LaTeX 出力を使用している場合は、makedocs の format 引数を format = Documenter.LaTeX(...) に変更し、DocumenterLaTeX パッケージへのすべての参照を削除してください（例: docs/Project.toml から）。

Added

  • 方程式としてレンダリングされ、text/latex 表現が表示方程式の区切り \[ ... \] または $math ...$ で囲まれているオブジェクトは、HTML 出力で正しく処理されるようになりました。(#1278, #1283, #1426)

  • HTML出力の検索ページでは、検索結果にページタイトルが表示されるようになりました。(#1468)

  • HTMLフロントエンドは、ユーザーのOSレベルのダークテーマの設定を尊重するようになりました（prefers-color-scheme: darkメディアクエリを介して決定されます）。 (#1320, #1456)

  • HTML出力は、ページがない場合にUndefRefErrorをスローするのではなく、早期に終了します。さらに、index.mdが欠落している場合、メインのランディングページ（index.html）を生成できないことを警告します。(#1201, #1491)

  • deploydocs は現在、現在のブランチが main であるが devbranch = "master" の場合に、GitHub Actions、Travis CI、および Buildkite で警告を表示します。これは、GitHub がリポジトリのデフォルトのプライマリブランチを main に変更したことによる Documenter の設定ミスの可能性を示しています。 (#1489)

Version v0.25.5 - 2020-11-23

Fixed

  • HTML出力では、ページよりも幅の広い方程式がオーバーフローするのではなく、スクロールバーが表示されるようになりました。 (#1470, #1476)

Version v0.25.4 - 2020-11-19

Added

  • Documenterは、Documenter.Buildkiteを使用してBuildkite CIからGitHub Pagesにデプロイできるようになりました。(#1469)

  • Documenterは、リポジトリを指す編集およびソースリンクを生成する際にAzure DevOps Repos URLスキームをサポートするようになりました。(#1462, #1463, #1471)

Fixed

  • Unionの型エイリアス（例：const MyAlias = Union{Foo,Bar}）は、ドキュメント文字列で「型」として正しくリストされるようになりました。(#1466, #1474)

  • HTMLWriterは、リンク内のmailto: URLに遭遇した際にもはや警告を出力しません。 (#1472)

Version v0.25.3 - 2020-10-28

Added

  • Documenterは、Documenter.GitLabを使用してGitLab CIからGitHub Pagesにデプロイできるようになりました。(#1448)

  • MathJax JSモジュールへのURLは、コンストラクタ（MathJax2、MathJax3）にurlキーワード引数を渡すことでカスタマイズできるようになりました。(#1428、#1430)

Fixed

  • Documenter.doctest は、Documenter.makedocs と同様に doctestfilters キーワードを正しく受け入れるようになりました。 (#1364, #1435)

  • Selectors.dispatch 関数は、makedocs 呼び出し中にセレクタに対して subtypes を複数回呼び出すのを避けるためにキャッシュを使用するようになりました。これにより、[subtypes が遅い][julia-38079] ことによる遅延を回避します。 (#1438, #1440, #1452)

Version v0.25.2 - 2020-08-18

Deprecated

  • Documenter.MathJax タイプは、HTML 出力における数学レンダリングエンジンを指定するために使用されていましたが、現在は Documenter.MathJax2 に置き換えられています。 (#1362, #1367)

    アップグレードするには: MathJax を MathJax2 に置き換えるだけです。つまり、次のようにします。

    makedocs(
    format = Documenter.HTML(mathengine = Documenter.MathJax(...), ...),
    ...
)

    あなたは持っているべきです

    makedocs(
    format = Documenter.HTML(mathengine = Documenter.MathJax2(...), ...),
    ...
)

Added

  • 現在、HTML出力で数学のレンダリングにMathJax v3を使用することが可能です。これは、HTMLにmathengineキーワードとしてDocumenter.MathJax3を渡すことで実現できます。(#1362, #1367)

  • Documenterによって作成されたデプロイメントコミットは、もはや@zeptodoctorユーザーによって署名されていませんが、存在しないdocumenter@juliadocs.github.ioメールアドレスで署名されています。(#1379, #1388)

Fixed

  • REPL doctest の出力行は、入力コード部分の直後に # で始まる行が、標準的なヒューリスティックに従って7つのスペースで前置きされていない限り、出力の一部として正しく扱われるようになりました。 (#1369)

  • Documenterは、Markdownコードブロックの情報文字列から余分な情報を捨てるようになりました（つまり、```language extra-info）。これにより、言語を正しく判断できるようになり、言語は単語1つである必要があります。(#1392, #1400)

  • Documenterは、元のdoctest出力が空であった場合にdoctest修正が壊れるJulia 1.5.0の回帰（JuliaLang/julia#36953）に対処するようになりました。（#1337、#1389）

Version v0.25.1 - 2020-07-21

Added

  • 自動的にページリストを決定する際（すなわち、makedocsにpagesが渡されていない場合）、Documenterは他のページの前にindex.mdをリストします。(#1355)

  • @example ブロックの出力テキストボックスは、入力と出力を視覚的に区別しやすくするために、コードブロックとは異なるスタイルになりました。 (#1026, #1357, #1360)

  • 生成されたHTMLサイトは、デフォルトでJuliaとDocumenterに言及するフッターを表示します。これは、Documeter.HTMLにfooterキーワードを渡すことでカスタマイズまたは無効にできます。(#1184, #1365)

  • strict=true に設定されているときに makedocs がエラーを引き起こす警告は、strict が true に設定されているときにエラーとして表示されるようになりました。 (#1088, #1349)

Fixed

  • PDF/LaTeX出力では、alignまたはalign*環境を使用する方程式は、もはやequation*/splitでさらにラップされることはありません。

Version v0.25.0 - 2020-06-30

Added

  • deploydocsを使用してデプロイする際、任意のSSHユーザー名を使用できるようになりました（gitだけではありません）。repo引数のリポジトリURLの前にusername@を追加してください。(#1285)

  • 各ページの最初のリンクフラグメントは、番号を省略するようになりました。以前はレンダリング結果が #foobar-1、#foobar-2 でしたが、現在は #foobar、#foobar-2 となっています。後方互換性のために、古いフラグメントも挿入されており、古いリンクは同じ場所を指し続けます。(#1292)

  • CIでdeploydocsを使用してデプロイする際、バージョン番号のビルド情報（つまり、+の後に来るもの）は、宛先ディレクトリを決定する際に現在は破棄されます。これにより、すでに登録されているバージョンのドキュメントビルドおよびデプロイメントの問題を修正するためにカスタムタグを使用できるようになります。(#1298)

  • プルリクエストプレビュービルドをメインドキュメントビルドとは異なるブランチおよび/または異なるリポジトリにプッシュすることをオプションで選択できるようになりました。これは、deploydocs関数のオプションのbranch_previewsおよび/またはrepo_previewsキーワード引数を設定することで実現できます。また、プレビュービルドに異なるSSHキーを使用することもオプションで選択できるようになりました。これは、オプションのDOCUMENTER_KEY_PREVIEWS環境変数を設定することで行います。DOCUMENTER_KEY_PREVIEWS環境変数が設定されていない場合は、通常のDOCUMENTER_KEY環境変数が使用されます。(#1307, #1310, #1315)

  • LaTeX/PDFバックエンドは、コンパイルされたPDFではなく、TeXソースファイルのみを出力するplatform="none"キーワードをサポートするようになりました。(#1338, #1339)

  • Linkcheckは、302 Foundの一時的なリダイレクトに遭遇した際に警告を印刷しなくなりました。(#1344, #1345)

Fixed

  • Deps.pip は再びクロージャであり、deploydocs 呼び出し中に実行され、実行前には実行されません。 (#1240)

  • カスタムアセット（CSS、JSなど）は、HTMLビルドの<head>タグの最後の要素として再度含まれるようになりました。これにより、デフォルトのアセットをオーバーライドすることが可能になります。(#1328)

  • @autodocs ブロックからのドキュメント文字列は、エクスポートされた名前がエクスポートされていない名前の前に来るという文書化されていないルールに従ってももはやソートされません。この動作が必要な場合、@autodocs は、最初のブロックでエクスポートされていないドキュメント文字列をフィルタリングする Public および Private オプションを使用する2つの別々のブロックに置き換えることができます。(#964, #1323)

Version v0.24.11 - 2020-05-06

Fixed

  • 一部のセクションとページタイトルが、HTMLバックエンドの検索結果に表示されるようになりました。(#1311)

Version v0.24.10 - 2020-04-26

Added

  • curl のタイムアウトは、リモートリンクをチェックする際に linkcheck_timeout キーワードで設定可能になりました。 (#1057, #1295)

Fixed

  • 特別な文字は、LaTeX/PDFビルドの注意書きタイトルで適切にエスケープされ、PDFビルドが失敗することはなくなりました。 (#1299)

Version v0.24.9 - 2020-04-15

Fixed

  • Canonical URLsは、prettyurls=trueを使用する際に適切に整形されるようになりました（例：/path/ではなく/path/index.html）。(#1293)

Version v0.24.8 - 2020-04-13

Added

  • 非標準の注意喚起カテゴリがHTML出力の注意喚起<div>要素に（再び）適用されています（is-category-$category）。(#1279, #1280)

Version v0.24.7 - 2020-03-23

Fixed

  • onlyは、Julia 1.4のBaseからの新しいエクスポートであり、JS検索フィルターから削除されました。 (#1264)

  • LaTeXビルドのエラーを修正するために、特定の文字のエスケープが不適切なために発生した問題を解決します。 (#1118, #1119, #1200, #1269)

Version v0.24.6 - 2020-03-12

Added

  • ドキュメンターのSassソース内のいくつかの内部変数を再編成し、ドキュメンターのベーステーマの上にカスタムテーマを作成しやすくします。 (#1258)

Version v0.24.5 - 2020-01-31

Added

  • Documenterは、REPLスタイルのドクトテストブロックおよび@replブロックで「REPLソフトスコープ」（Julia 1.5）を正しくエミュレートします。(#1232)

Version v0.24.4 - 2020-01-18

Added

  • インラインコードをHTMLライトテーマで目立たない黒色に変更します。(#1212, #1222)

  • html タグの lang 属性を HTML 出力で指定できる機能を追加し、他の言語のドキュメントページをより良くサポートします。デフォルトでは、Documenter は現在 lang="en" に設定されています。 (#1223)

Version v0.24.3 - 2019-12-16

Fixed

  • ドキュメンターのデプロイメントが、非標準システムでgitが間違ったssh設定ファイルを拾って失敗するケースを修正しました。 (#1216)

Version v0.24.2 - 2019-11-26

Other

  • deploydocsのログ記録の改善。 (#1195)

Version v0.24.1 - 2019-11-25

Fixed

  • LaTeXWriterの悪いmktempdirの呪文を修正します。 (#1194)

Version v0.24.0 - 2019-11-22

Breaking

  • Documenterはもはや古いlatest URLと指定されたdevurlの間にシンボリックリンクを作成しません。 (#1151)

    アップグレードのために: 最新のドキュメントへのリンクが更新されていることを確認してください（例：パッケージのREADME）。

  • 非推奨の makedocs キーワード（html_prettyurls、html_disable_git、html_edit_branch、html_canonical、assets、analytics）は削除されました。(#1107)

    アップグレードのために: format キーワードを設定する際に、対応する値を HTML コンストラクタに渡してください。

Deprecated

  • Documenter.HTMLのedit_branchキーワードは、新しいedit_linkキーワードに置き換えられました。新機能として、edit_link = nothingを渡すことで、「GitHubで編集」リンクを完全に無効にします。(#1173)

    アップグレードのために: edit_branch = nothingを使用している場合は、代わりにedit_link = :commitを使用してください。edit_branchにStringを渡す場合は、それをedit_linkに渡してください。

Added

  • Documenterは、プルリクエストからプレビュー文書をデプロイできるようになりました（ヘッドブランチが同じリポジトリにある場合、つまりフォークからではありません）。これは、deploydocsにpush_preview=trueを渡すことで有効になります。(#1180)

  • デプロイメントはよりカスタマイズ可能になり、以前ほどTravis CIに依存しなくなりました。 (2331313437_68747470733a2f2f6769746875622e636f2e636f6d2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f31313437, 2331313731_68747470733a2f2f6769746875622e636f2e636f6d2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f31313731, 2331313830_68747470733a2f2f6769746875622e636f2e636f6d2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f31313830)

  • Documenterは、GitHub Actionsからのデプロイをサポートするビルトイン機能を持っています。Documenterは、明示的に指定されない限り、実行中のシステムを自動的に検出します。(#1144, #1152)

  • GitHub Actionsを使用する際、Documenterは生成されたドキュメントへのリンクを含むGitHubステータスを（試みて）投稿します。これは特にプルリクエストのプレビュービルドに便利です（上記を参照）。 (#1186)

  • ドキュメンターのHTMLフロントエンドは、現在デフォルトの数学レンダリングエンジンとして KaTeX を使用しています。 (#1097)

    可能な破損: これは、MathJaxでのみサポートされているいくつかのより難解な機能を使用する方程式のレンダリングを壊す可能性があります。formatキーワードのHTMLコンストラクタにmathengine = Documenter.MathJax()を渡すことで、MathJaxに戻すことが可能です。

  • Documenterによって生成されたHTMLフロントエンドは再設計され、現在はBulma CSS frameworkを使用しています。(#1043)

    可能な破損: デフォルトのDocumenter CSSファイルを上書きするパッケージ、外部CSSに依存するパッケージ、またはDocumenterのCSSが特定の方法で動作することに依存するパッケージは、正しく見えるサイトをビルドできません。カスタムテーマは、Sassファイルとして開発され、DocumenterおよびBulma Sass依存関係と一緒にコンパイルされるべきです（assets/html/scssの下）。

  • JSおよびCSSアセットの取り扱いは、現在よりカスタマイズ可能になりました：

    • asset 関数は、assets キーワードでリモート JS および CSS アセットを宣言するために使用できるようになりました。 (#1108)
    • highlights キーワードを HTML に使用して、コードブロックでハイライトされるべき追加の言語を宣言できます。 (#1094)
    • 現在、mathengineキーワードをHTMLに設定することで、MathJaxとKaTeXの間で数式レンダリングエンジンを選択できるようになり、make.jlスクリプト内でその設定を直接行うことができます。(#1097)

  • フロントエンドのJSおよびCSSの依存関係が最新バージョンに更新されました。 (#1189)

  • サイドバーの上部にサイト名を表示しないようにするには、formatキーワードのHTMLにsidebar_sitename = falseを渡します。 (#1089)

  • Google Analyticsが有効なデプロイメントでは、URLフラグメント（つまり、ページ内の#ターゲット）も分析に保存されます。(#1121)

  • ページタイトルは現在検索で強化されており、より良い検索結果をもたらしています。 (#631, #1112, #1113)

  • PDF/LaTeX出力では、テキストよりも幅の広い画像が自動的にテキスト幅にスケーリングされるようになりました。PDFビルドには、adjustbox LaTeXパッケージが利用可能である必要があります。(#1137)

  • If the TeXコンパイルがPDF/LaTeX出力のために失敗した場合、makedocsは現在例外をスローします。 (#1166)

Fixed

  • LaTeXWriterは、@contentsブロックが2階層以上にネストされている場合、または@contentsや@indexブロックにアイテムが含まれていない場合に、有効なLaTeXを出力します。(#1166)

Version v0.23.4 - 2019-10-09

Fixed

  • include および eval 関数は、現在 @setup ブロック内でも利用可能です。 (#1148, #1153)

Version v0.23.3 - 2019-08-28

Fixed

  • ファイルの権限エラーを修正するには、Pkg.testでDocumenterをテストします。 (#1115)

Version v0.23.2 - 2019-08-04

Fixed

  • 空のMarkdown見出しはもはやDocumenterをクラッシュさせません。 (#1081, #1082)

Version v0.23.1 - 2019-07-28

Fixed

  • Documenterは、提供されたEditURL引数が欠落している場合にエラーをスローしなくなりました。(#1076, #1077)

  • 非標準Markdown ASTノードは、ドクトテストおよびHTML出力でDocumenterがメソッド不足エラーで終了する原因となりません。Documenterはそのようなノードに対してrepr()にフォールバックします。(#1073, #1075)

  • Docstrings parsed into nested Markdown.MD objects are now unwrapped correctly and do not cause Documenter to crash with a missing method error anymore. The user can run into that when reusing docstrings with the @doc @doc(foo) function bar end pattern. (#1075)

Version v0.23.0 - 2019-07-18

Version changes

  • Documenter v0.23 は Julia v1.0 を必要とします。(#1015)

Breaking

  • @meta ブロックで定義された DocTestSetup は、ドキュメント文字列内のドクトストには適用されなくなりました。 (#774)

    • 具体的には、@docs または @autodocs ブロックが @meta ブロックに囲まれ、複数のドキュメント文字列のために共有の DocTestSetup を設定するパターンは、もはや機能しません。

    • Documenterは現在、DocMetaモジュールをエクスポートしており、これによりドキュメント文字列にDocTestSetupを追加する別の方法が提供されます。

    アップグレードのために: make.jlでDocMeta.setdocmeta!を使用して、特定のモジュール内のすべてのドキュメント文字列に適用されるDocTestSetupを設定し、該当する場合は現在不要な@metaブロックを削除してください。詳細については、マニュアルの"Setup code" section under "Doctesting"を参照してください。

Added

  • makedocs は doctest = :only キーワードを受け入れるようになり、これによりレンダリングなどの他のビルドステップをスキップしながらドクトテストを実行できるようになりました。これにより、テストスイートの一部としてドクトテストを実行することがより実現可能になります（詳細についてはマニュアルを参照してください）。 (#198, #535, #756, #774)

  • Documenterは、指定されたモジュールのすべてのドックストリング内のドクトテストを検証するdoctest関数をエクスポートします。これは、テストスイートの一部としてドックストリングのドクトテストを検証したり、REPL内で直接ドクトテストを修正したりするために使用できます。(#198, #535, #756, #774, #1054)

  • makedocs は expandfirst 引数を受け入れるようになり、他のページの前に評価されるべきページのセットを指定できるようになりました。(#1027, #1029)

  • ページの評価順序は現在固定されています（expandfirstでカスタマイズしない限り）。ページはファイルパスのアルファベット順に評価されます。(#1027, #1029)

  • HTML出力のロゴ画像は、ナビゲーションメニューの最初のページを常に指すようになります（存在するかどうかは関係なく、index.htmlではありません）。きれいなURLを使用する場合、ロゴリンクのURLからindex.html部分は省略されます。(#1005)

  • ドクトestingエラーの印刷方法に小さな変更を加えました。(#1028)

  • 動画は、ファイル拡張子が既知のフォーマット（.webm, .mp4, .ogg, .ogm, .ogv, .avi）と一致する場合、画像構文（![]()）を使用してHTML出力に含めることができます。(#1034)

  • PDF出力は現在、より良いUnicodeカバレッジを提供するためにDejaVu SansおよびDejaVu Sans Monoフォントを使用しています。(#803, #1066)

  • 実験的 @repl および @example ブロックを評価する際の現在の作業ディレクトリは、makedocs に workdir キーワードを渡すことで固定ディレクトリに設定できるようになりました。新しいキーワードとその動作は実験的であり、公開APIの一部ではありません。 (#1013, #1025)

Fixed

  • HTML出力は、pagesキーワードで参照されていないページのHTMLファイルも出力するようになりました（Documenterは拡張子に基づいてそれらを見つけます）。しかし、それらはpagesで定義された標準のナビゲーション階層の外に存在します。これにより、これらのページが@refリンクや@contentsブロックで参照されることができたバグが修正されましたが、HTML出力ではリンクが壊れてしまうことがありました。(#1031, #1047)

  • makedocsは、フォーマットオブジェクト（Documenter.HTML、LaTeX、Markdown）が位置引数として渡されたときにエラーをスローします。フォーマットタイプはもはやDocumenter.Pluginのサブタイプではありません。(#1046、#1061)

  • Doctestingは、無効な構文を含み、解析エラーを引き起こすdoctestsも処理できるようになりました。(#487, #1062)

  • doctest でエラーをスローするスタックトレースは、より徹底的にフィルタリングされるようになりました。これにより、doctest または makedocs がより複雑なコンテキストから呼び出されたときに、スタックトレースの情報が多すぎるという問題が修正されました。 (#1062)

Version v0.22.6 - 2019-07-18

Other

  • DocStringExtensions 0.8を許可された依存関係のバージョンとして追加します。 (#1071)

Version v0.22.5 - 2019-07-03

Fixed

  • テスト依存関係の問題を修正しました。Julia / Pkgのバグ修正によって明らかになりました。(#1037)

Version v0.22.4 - 2019-05-09

Fixed

  • Documenterは、ビルドにファイルシステム上に存在しないファイルに定義されたドクトストリングからのドクトテストが含まれている場合（例えば、非ソースのJuliaビルドを実行しているときにJulia Baseのドクトストリングが含まれている場合）にクラッシュしなくなりました。 (#1002)

  • リポジトリ内のファイルのURLは、リポジトリが別のリポジトリのGitサブモジュールとして使用されるときに正しく生成されるようになりました。(#1000, #1004)

  • ドキュメント文字列が省略されているかどうかを確認する際、Documenterはもはや「Package.Package が欠けています」というタイプの誤検知を行いません。 (#1009)

  • makedocs は strict=true の場合、ドクトテストの失敗があると再度エラーで終了します。 (#1003, #1014)

Version v0.22.3 - 2019-04-12

Fixed

  • 固定されたファイルパスは、Windows上でPDF出力のための.texファイルに含まれる画像用です。(#999)

Version v0.22.2 - 2019-04-05

Fixed

  • メタブロックのエラーレポートは、ファイルが見つからない場合に例外をスローするのではなく、優雅に処理するようになりました。 (#996)

Added

  • deploydocsへのsitenameキーワード引数は、デフォルトのHTML出力に必要であり、適切に文書化されました。(#995)

Version v0.22.1 - 2019-03-30

Fixed

  • ドクトストに関連する世界年齢のバグを修正しました。 (#994)

Version v0.22.0 - 2019-03-28

Deprecated

  • makedocsへのassetsおよびanalytics引数は、Documenter.HTMLフォーマットプラグインの対応する引数に置き換えられました。(#953)

    アップグレードするには: 代わりに Documenter.HTML プラグインに対応する引数を渡してください。例えば、次のようにします。

    makedocs(
    assets = ..., analytics = ...,
    ...
)

    あなたは持っているべきです

    makedocs(
    format = Documenter.HTML(assets = ..., analytics = ...),
    ...
)

    ***注意:** 技術的には、異なる値を持つ同じ引数を2回指定することが可能であり、その場合はmakedocsに渡された値が優先されます。*

Added

  • ドキュメントはもはやTravis CIのcronジョブにデプロイされていません。 (#917)

  • 失敗した @meta、@docs、@autodocs、@eval、@example および @setup ブロックからのログメッセージには、ブロックのソース位置に関する情報が含まれるようになりました。 (#929)

  • @docsブロックからのドキュメント文字列は、ブロックの一部が失敗した場合でも、レンダリングされたドキュメントに含まれるようになりました。(#928, #935)

  • MarkdownとLaTeXの出力ライターは、@exampleブロックからの画像などのマルチメディア出力を処理できるようになりました。すべてのライターは、利用可能な場合はtext/plainよりも好まれるtext/markdown出力も処理します。(#938, #948)

  • HTML出力は現在、SVG、WebP、GIF、およびJPEGロゴもサポートしています。 (#953)

  • 失敗したドクトテストの報告は、Documenterの出力の他の部分と一貫性を持たせるために、ロギングシステムを使用するようになりました。 (#958)

  • HTML出力における検索インデックスの構築がリファクタリングされ、将来的に他の検索バックエンドと一緒に使用しやすくなりました。生成された検索インデックスの構造も変更されており、わずかに異なる検索結果をもたらす可能性があります。Documenterは現在、軽量の JSON.jl パッケージに依存しています。(#966)

  • インデントされたコードブロック（関数シグネチャなど）で始まるドックストリングは、デフォルトでそのブロックがJuliaコードとしてハイライトされるようになりました。この動作は、makedocsにhighlightsig=falseを渡すことで無効にできます。 (#980)

Fixed

  • @eval、@example、@repl、および jldoctest ブロック内の include 呼び出しのパスは、結果のファイルの出力ディレクトリに設定された相対 pwd として解釈されるようになりました。 (#941)

  • deploydocs と git_push は、非GitHubリポジトリを正しくサポートし、.ssh ディレクトリがまだ存在しない場合や作業ディレクトリにスペースが含まれている場合でも動作します。 (#971)

  • テーブルは現在、HTML出力において列の整列を尊重します。列が明示的に整列を指定しない場合、パーサーはデフォルトで右揃えとし、以前はすべてのセルが左揃えでした。(#511, #989)

  • # hideで終わるコード行は、CRLF入力に対して適切に隠されるようになりました。(#991)

Version v0.21.5 - 2019-02-22

Fixed

  • formatに対する非推奨警告は、複数のフォーマットがVectorとして渡されたときに正しく表示されるようになりました。(#967)

Version v0.21.4 - 2019-02-16

Fixed

  • jldoctestブロックのバグが修正されました。このバグは、稀に誤った出力を引き起こすものでした。(#959, #960)

Version v0.21.3 - 2019-02-12

Security

  • lunr.js と lodash の JavaScript 依存関係が最新のパッチバージョンに更新されました（それぞれ 2.3.1 から 2.3.5、4.17.4 から 4.17.11 へ）。これは lodash <4.17.11 における脆弱性に対応したものです (CVE-2018-16487)。(#946)

Version v0.21.2 - 2019-02-06

Fixed

  • linkcheck は HEAD リクエストをサポートしないサーバーを処理し、FTP レスポンスのステータスコードを適切にチェックします。 (#934)

Version v0.21.1 - 2019-01-29

Fixed

  • @repl ブロックは、引用された式と正しく動作するようになりました。(#923, #926)

  • @example、@repl、および @eval ブロックは、try/catch などの予約語を正しく処理するようになりました。(#886、#927)

Version v0.21.0 - 2018-12-11

Deprecated

  • makedocsのformat引数に対するシンボル値（:html、:markdown、:latex）は、Documenter.HTML、Markdown、およびLaTeXオブジェクトに置き換えられました。MarkdownおよびLaTeXタイプは、それぞれDocumenterMarkdownおよびDocumenterLaTeXパッケージからエクスポートされています。HTML出力は依然としてデフォルトです。(#891)

    アップグレードのために: formatを指定しない場合（つまり、デフォルトに依存する場合）、何もする必要はありません。それ以外の場合は、シンボルの代わりに構造体インスタンスを使用するようにmakedocsへの呼び出しを更新してください。例えば、

    makedocs(
    format = :markdown
)

    変更する必要があります

    using DocumenterMarkdown
makedocs(
    format = Markdown()
)

  • makedocsへのhtml_prettyurls、html_canonical、html_disable_git、およびhtml_edit_branch引数は、Documenter.HTMLフォーマットプラグインの対応する引数に置き換えられたため、非推奨となりました。(#864、#891)

    アップグレードするには: 代わりに Documenter.HTML プラグインに対応する引数を渡してください。例えば、次のようにします。

    makedocs(
    html_prettyurls = ..., html_canonical = ...,
    ...
)

    あなたは持っているべきです

    makedocs(
    format = Documenter.HTML(prettyurls = ..., canonical = ...),
    ...
)

    ***注意:** 技術的には、異なる値を持つ同じ引数を2回指定することが可能であり、その場合は非推奨の html** バリアントの値が優先されます。_

Added

  • パッケージがDocumenterを拡張する際、Documenter.Pluginのサブタイプを定義できるようになりました。これにより、拡張機能にオプションを渡すために、makedocsに位置引数として渡すことができます。 (#864)

  • @autodocs ブロックは現在、Filter キーワードをサポートしており、ユーザー定義の関数を渡すことで、at-autodocs ブロックによってスプライスされたメソッドをフィルタリングすることができます。 (#885)

  • linkcheck は、FTPプロトコルを使用してURLをチェックすることをサポートしています。 (#879)

  • ビルド出力のログ記録が改善され、Baseのログ記録マクロに切り替えられました。 (#876)

  • デフォルトの documenter.sty LaTeX プリアンブルには、現在 \usepackage{graphicx} が含まれています。 (#898)

  • deploydocsは、DOCUMENTER_KEYを解釈できない場合に、より役立つようになりました。現在、BatchMode SSHオプションも使用し、DOCUMENTER_KEYが壊れている場合にはパスフレーズを要求するのではなくエラーをスローし、Travisビルドがタイムアウトすることを防ぎます。(#697, #907)

  • deploydocs には、新しいコミットを追加する代わりにビルドされたドキュメントを強制プッシュするために使用できる forcepush キーワード引数が追加されました。 (#905)

Version v0.20.0 - 2018-10-27

Version changes

  • Documenter v0.20 は少なくとも Julia v0.7 を必要とします。(23373935_68747470733a2f2f6769746875622e636f2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f373935)

Breaking

  • deploydocs 関数を介したドキュメントのデプロイが大幅に変更されました。

    • ユーザー向けのディレクトリ（URL）の異なるバージョンと、バージョンセレクタに表示される内容が変更されました。デフォルトでは、Documenterは以前と同様にstable/ディレクトリと、各マイナーバージョンのためのディレクトリ（vX.Y/）を作成します。release-X.Yディレクトリはもはや作成されません。(#706, #813, #817)

      技術的には、Documenterは現在、実際のファイルをdev/およびvX.Y.Z/ディレクトリにのみデプロイします。バージョンごとに変更されるディレクトリ（URL）（例：latest/、vX.Y）は、gh-pagesブランチ上でシンボリックリンクとして実装されています。

      バージョンセレクタはデフォルトで vX.Y/、stable/ および dev/ ディレクトリのみを表示します。この動作は deploydocs の versions キーワードを使用してカスタマイズできます。

    • 開発ブランチ（例：master）からのドキュメントは、デフォルトでdev/にデプロイされます（latest/の代わりに）。これはdevurlキーワードでカスタマイズできます。(#802)

    • deploydocs に対する latest キーワードは非推奨となり、devbranch に名前が変更されました。 (#802)

    • deploydocsへのjuliaおよびosnameキーワードは現在非推奨です。(#816)

    • deploydocsのtarget、deps、およびmakeキーワードのデフォルト値が変更されました。詳細については、以下のデフォルトフォーマットの変更を参照してください。(#826)

    アップグレードのために:

    • latest キーワードを使用している場合は、同じ値を持つ devbranch を代わりに使用してください。

    • latest/を指すリンクをdev/に更新してください（例：README内で）。

    • release-X.Y ブランチへのリンクを削除し、gh-pages ブランチからディレクトリを削除してください。

    • Travisビルドステージの設定では、オペレーティングシステムとJuliaのバージョンを指定する必要があります（julia:およびos:オプションを使用、詳細についてはマニュアルの「ホスティングドキュメント」を参照）または、make.jl内で自分でTRAVIS_JULIA_VERSIONおよびTRAVIS_OS_NAME環境変数を確認することによって指定できます。

  • makedocs はデフォルトで Documenter's ネイティブ HTML 出力をビルドするようになり、deploydocs のデフォルトは HTML 出力を前提としています。 (23383236_68747470733a2f2f6769746875622e636f2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f383236)

    • makedocsのformatキーワードのデフォルト値が:htmlに変更されました。

    • deploydocsのtargetキーワードのデフォルト値が"build"に変更されました。

    • deploydocsのmakeおよびdepsキーワードのデフォルト値がnothingに変更されました。

    アップグレードのために: Markdown/MkDocsの出力に依存している場合、今後は以下を行う必要があります:

    • makedocs で format = :markdown を明示的に設定します。

    • deploydocsで明示的に設定します。

      target = "site"
deps = Deps.pip("pygments", "mkdocs")
make = () -> run(`mkdocs build`)

    • make.jlでDocumenterMarkdownを明示的にインポートしてください。以下のMarkdownWriterの非推奨について参照してください。

    変更されたキーワードのいずれかをすでに指定している場合、すでに設定したキーワードに対して変更を加える必要はありません。

    ただし、既にHTML出力を使用している場合など、新しいデフォルト値に設定する場合は、新しいデフォルト値を信頼することができます。

  • 「Pretty URLs」は、HTML出力のデフォルトで有効になりました。html_prettyurlsのデフォルト値はtrueに変更されました。

    foo/page.md のページに対して、Documenter は現在 foo/page/index.html を生成します。これにより、GitHub ページのデプロイメントでは、URL が foo/page/ の形式になり、foo/page.html ではなくなります。

    ローカルビルドの場合は、html_prettyurls = falseを明示的に設定する必要があります。

    アップグレードのために: 古い動作を保持したい場合は、makedocsでhtml_prettyurls = falseを設定してください。すでにhtml_prettyurlsを設定している場合は、何も変更する必要はありません。

  • Travis.genkeys と Documenter.generate 関数は、別の DocumenterTools.jl package に移動されました。 (#789)

Deprecated

  • Markdown/MkDocs (format = :markdown) と PDF/LaTeX (format = :latex) の出力は、現在外部パッケージをロードする必要があります（DocumenterMarkdown と DocumenterLaTeX、それぞれ）。(#833)

    アップグレードのために: 対応する追加パッケージがインストールされていることを確認し、その後 make.jl に using DocumenterMarkdown または using DocumenterLaTeX を追加してください。

Added

  • If DocumenterがソースをホストしているGitホスティングサービスを特定できない場合、「Edit on XXX」リンクは「Edit source」となり、一般的なアイコンが表示されます。(23383034_68747470733a2f2f6769746875622e636f2f4a756c6961446f63732f446f63756d656e7465722e6a6c2f6973737565732f383034)

  • at-blocksは、オブジェクトのMIME"text/html"レンダリングをサポートするようになりました（例：インタラクティブプロット用）。つまり、型がshow(io, ::MIME"text/html", x)を定義している場合、Documenterはドキュメント内のオブジェクトをレンダリングする際にそれを使用します。(#764)

  • サイドバーに追加されました。ページを読み込むと、サイドバーは現在のページにジャンプします。また、WebKitベースのブラウザでのスクロールバーは、今ではあまり目立たなくなりました。(#792, #854, #863)

  • マイナーなスタイルの改善を注意喚起に適用しました。

Fixed

  • コードを実行する at-blocks は、include ステートメントを処理できるようになりました。 (#793, #794)

  • At-docs ブロックは、空行を含む場合でもエラーを出さなくなりました。(#823, #824)