Merged
Conversation
added 11 commits
November 5, 2023 14:17
次のコマンドを使用してこのディレクトリからツールを呼び出すことができます: 'dotnet tool run docfx' または 'dotnet docfx'。 バージョン固定するためにローカルインストールにしている。
最小限にするためにarticlesは削除 docsというフォルダ名はUniTaskや公式リポジトリをみてdocsというフォルダ名を使っていることを確認したためそれを使用 https://github.com/Unity-Technologies/ml-agents/tree/develop/docs 最小限APIリファレンスさえあればいいためコマンドで生成されたarticlesフォルダは削除した。 dotnet docfx docs/docfx.json --serve で確認できる
生成する対象のファイルを指定。 ドキュメント https://dotnet.github.io/docfx/reference/docfx-json-reference.html#file-mappings ## filesの指定方法 csproj, dll, csの3択ありそう。 https://dotnet.github.io/docfx/docs/dotnet-api-docs.html#generate-from-source-code UnityEngineへの参照を回避できるのはcsのみのためそれを使用している。
APIReferenceのindexが不要だったため削除 toc.ymlのhomepageにはmetadataによって生成したファイル名を書くようたっだためymlを指定 > /UnityProjects/CoreBluetoothForUnity/docs/toc.yml(0,1): warning InvalidFileLink: Invalid file link:(~/api/CoreBluetooth.html).
_siteフォルダを消さないと新しく生成してくれなかったため
UniTaskのを真似た https://cysharp.github.io/UniTask/
https://dotnet.github.io/docfx/reference/docfx-json-reference.html#predefined-metadata 外部サイトだったら別リンクに飛んでほしいため_enableNewTabはtrueにした。 ただし、Repositoryはnewタブにならなかった
ソースコードと同じ順に並べてほしいため
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
APIリファレンスを追加。
UnityEngineがなくてもdocfxでコンパイルできるようにするために docfx.json の files で .csを指定している。
Foundationを別packageにする場合には 生成する前に Foundation のリポジトリをクローンしてソースコード移動させるしかないかなと今のところは思っている。