Skip to content

Commit

Permalink
docs: docfx tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
andywiecko committed Apr 19, 2024
1 parent c50cc67 commit 4ab9534
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
8 changes: 8 additions & 0 deletions Documentation~/docfx/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Documentation

1. Place `.dll` files for `Unity`, `Burst`, `Collections`, etc. in the `dlls/` folder.
2. Navigate to the `Documentation~/docfx` folder.
3. Build documentation using `docfx`. Optionally, if `make` is available, run `make serve` to build and open documentation in the browser.

> [!NOTE]
> `unity-xrefmap.yml` contains cross-references between packages. This file is filled manually since there are only a few references to external definitions in the public API.
1 change: 1 addition & 0 deletions Documentation~/docfx/dlls/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.dll
3 changes: 2 additions & 1 deletion Documentation~/docfx/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"src": [{"src": "../../Runtime", "files": ["**/*.cs"]}],
"dest": "api",
"allowCompilationErrors": true,
"memberLayout": "separatePages"
"memberLayout": "separatePages",
"references": "dlls/*"
}
],
"build": {
Expand Down
13 changes: 7 additions & 6 deletions Documentation~/docfx/unity-xrefmap.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
references:
- uid: NativeList`1
- uid: Unity.Collections.NativeList`1
name: NativeList<T>
href: https://docs.unity3d.com/Packages/[email protected]/api/Unity.Collections.NativeList-1.html

- uid: NativeReference`1
- uid: Unity.Collections.NativeReference`1
name: NativeReference<T>
href: https://docs.unity3d.com/Packages/[email protected]/api/Unity.Collections.NativeReference-1.html

- uid: NativeArray`1
- uid: Unity.Collections.NativeArray`1
name: NativeArray<T>
href: https://docs.unity3d.com/2022.3/Documentation/ScriptReference/Unity.Collections.NativeArray_1.html

- uid: Allocator
- uid: Unity.Collections.Allocator
name: Allocator
href: https://docs.unity3d.com/2022.3/Documentation/ScriptReference/Unity.Collections.Allocator.html

- uid: JobHandle
- uid: Unity.Jobs.JobHandle
name: JobHandle
type: struct
href: https://docs.unity3d.com/2022.3/Documentation/ScriptReference/Unity.Jobs.JobHandle.html

- uid: float2
- uid: Unity.Mathematics.float2
name: float2
href: https://docs.unity3d.com/Packages/[email protected]/api/Unity.Mathematics.float2.html

0 comments on commit 4ab9534

Please sign in to comment.