Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,21 @@ jobs:
- name: Install DocFX
run: dotnet tool install -g docfx --version 2.77.0

- name: Cache Unity managed DLLs
id: cache-unity-dlls
uses: actions/cache@v4
with:
path: lib/UnityEngine
key: unity-managed-dlls-6000.0.73f1-v1

- name: Extract Unity managed DLLs from game-ci image
if: steps.cache-unity-dlls.outputs.cache-hit != 'true'
run: |
mkdir -p lib
docker create --name unity-editor unityci/editor:ubuntu-6000.0.73f1-linux-il2cpp-3.2.2
docker cp unity-editor:/opt/unity/Editor/Data/Managed/UnityEngine lib/
docker rm unity-editor

- name: Use README.md as index.md
run: cp README.md Documentation/index.md

Expand Down
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ Packages/*
## Autogenerated VS/MD/Consulo solution and project files
ExportedObj/
.consulo/
*.csproj
!DocFxForUnity.csproj
Assembly-CSharp*.csproj
Assembly-CSharp-Editor*.csproj
lib/
*.unityproj
*.sln
*.suo
Expand Down
19 changes: 19 additions & 0 deletions DocFxForUnity.csproj
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.1</TargetFramework>
<!--
In CI: Unity managed DLLs are extracted to lib/UnityEngine/ by the workflow.
Locally: set the UNITY_MANAGED_PATH environment variable to your Unity installation:
Windows: C:\Program Files\Unity\Hub\Editor\6000.0.73f1\Editor\Data\Managed\UnityEngine
macOS: /Applications/Unity/Hub/Editor/6000.0.73f1/Unity.app/Contents/Managed/UnityEngine
Linux: ~/Unity/Hub/Editor/6000.0.73f1/Editor/Data/Managed/UnityEngine
-->
<UnityManagedPath Condition="'$(UNITY_MANAGED_PATH)' != ''">$(UNITY_MANAGED_PATH)</UnityManagedPath>
<UnityManagedPath Condition="'$(UnityManagedPath)' == ''">lib/UnityEngine</UnityManagedPath>
</PropertyGroup>

<Target Name="AddUnityReferences" BeforeTargets="ResolveAssemblyReferences">
<ItemGroup>
<_UnityDll Include="$(UnityManagedPath)/*.dll" />
<Reference Include="%(_UnityDll.Filename)">
<HintPath>%(_UnityDll.FullPath)</HintPath>
<Private>false</Private>
</Reference>
</ItemGroup>
</Target>
</Project>
3 changes: 1 addition & 2 deletions Documentation/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
"globalNamespaceId": "Global",
"filter": "filterConfig.yml",
"dest": "api",
"allowCompilationErrors": true,
"disableGitFeatures": true
}
],
Expand Down Expand Up @@ -70,7 +69,7 @@
}
},
"xref": [
"https://normanderwan.github.io/UnityXrefMaps/xrefmap.yml",
"https://normanderwan.github.io/UnityXrefMaps/6000.0/xrefmap.yml",
"https://learn.microsoft.com/en-us/dotnet/.xrefmap.json"
],
"dest": "../_site"
Expand Down
2 changes: 1 addition & 1 deletion ProjectSettings/ProjectVersion.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
m_EditorVersion: 2017.4.26f1
m_EditorVersion: 6000.0.73f1
Loading