ci: replace docfx build from container to docfx command#677
Merged
guitarrapc merged 3 commits intomasterfrom Sep 12, 2025
Merged
ci: replace docfx build from container to docfx command#677guitarrapc merged 3 commits intomasterfrom
guitarrapc merged 3 commits intomasterfrom
Conversation
mayuki
approved these changes
Sep 10, 2025
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
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
The current docfx build using containers is failing (example build log), and this cannot be resolved from the user side. Let's change the documentation build process to use the docfx .NET tool instead.
doc generation was stopped for about 4 months, there are new APIs introduced, something like
UnityAsyncExtensions.AssetBundleCreateRequestAwaiter.Unity Assembly Considerations
UniTask is dependent on Unity, which means
UnityEngine.dlland other Unity-related DLLs are required to build UniTask. However, since Unity assemblies are not distributed under OSS licenses, we cannot build the UniTask documentation by compiling from source as docfx normally would. Instead, we need to reference the pre-compiled UniTask DLLs.When Unity loads the UniTask project (under
src/UniTask), it compiles assemblies intoUniTask/Library/ScriptAssemblies/UniTask*.dll. I have changed the docfx metadata source to use these assemblies, and API documentation is now generated successfully.Notable Side Effects
Previous
After