search

Unity-Technologies / Unity.Mathematics

The C# math library used in Unity providing vector types and math functions with a shader like syntax
Other
1.38k stars 156 forks source link

Add setting files to docs #170

Closed jo3w4rd closed 4 years ago

jo3w4rd commented 4 years ago

This PR does two things:

  1. Adds a filter.yml file with entries to remove test namespaces from the API reference

  2. Adds a projectMetadata.json settings file to enable the DocFX member page plugin. This plugin show API members on their own pages (overloads are combined on one page) and substantially helps load time and browsability.

Note that the MemberPage plugin integration in the package doc tool is still in testing. The presence of the control setting is simply ignored until that PR is merged.

unpacklo commented 4 years ago

Note that the MemberPage plugin integration in the package doc tool is still in testing. The presence of the control setting is simply ignored until that PR is merged.

@jo3w4rd That sounds really cool, how can I try this?

jo3w4rd commented 4 years ago

You can clone git@github.cds.internal.unity3d.com:unity/com.unity.package-manager-doctools.git and then checkout the global-namespace-memberpages-enum-sorting branch. Then in your Unity project, install the doc tools using the Package Manager "Add package from disk" feature. (I think this is the most foolproof way to do it.) Hopefully this works for you since you've been unable to run the tool in the past.

unpacklo commented 4 years ago

Do you have an example that shows the difference? I'm having trouble noticing what the actual difference is here when I generate locally with that branch, but it definitely still works.