Package Manager Documentation Tools

The Package Manager Documentation Tools (PMDT) package is a UI extension for the Package Manager that generates documentation for a package. It enables you to preview what the documentation for a package looks like in its final published form, and provides validation reports that check for issues with the documentation.

Important

This is an internal Unity tool and is not supported for external use. All installation methods require an Employee login and/or VPN connection.

Requirements

This version of Unity Package Manager Doc Tools is compatible with the following versions of the Unity Editor:

• 2019.4 and later

Installing DocFX

Important

Starting from PMDT 3.0.0 DocFX is not included and must be installed as a dotnet tool

If the recommended version of DocFX is not installed as a dotnet tool to the required path, PMDT posts installation or upgrade instructions to the Unity console in an error message or warning containing the following steps:

1. Install .net 7 from https://dotnet.microsoft.com/en-us/download/dotnet/7.0 (to the default location on Mac, /usr/local/share/dotnet)
2. run dotnet tool install docfx --version <preferred version> --tool-path <user profile directory>/.pmdt in Command Prompt (Windows) or Terminal (Mac/Linux)
3. run dotnet tool update docfx --version <preferred version> --tool-path <user profile directory>/.pmdt in Command Prompt (Windows) or Terminal (Mac/Linux)

At the time of writing the preferred version of DocFX is 2.70.0 and the install command resolves in Windows Command Prompt to:

dotnet tool install docfx --version 2.70.0 --tool-path %USERPROFILE%/.pmdt

The install command resolves in Windows Powershell to:

dotnet tool install docfx --version 2.70.0 --tool-path $env:USERPROFILE/.pmdt

The install command resolves on Mac to:

dotnet tool install docfx --version 2.70.0 --tool-path $HOME/.pmdt

Installing PMDT

You can install the Package Manager Doc Tools in one of the following ways:

As a local package

1. Clone the Package Manager Doc Tools repository.
2. Open a Unity project.
3. Open the Package Manager window.
4. Select Add package from disk.
5. Add the package.json file from the cloned repository.

As a scoped registry package

PMDT is released to Unity's internal package candidates registry. The candidates registry is part of the release process for public Unity packages (note: this link is to Unity's internal documentation and requires an employee login). It is called the candidates registry because it stores release candidate packages. PMDT is not a publicly available Unity package but publishing it to the candidates registry allows it to be distributed internally using Package Manager.

To install PMDT as a scoped registry package:

1. Create a Scoped Registry with the following settings:
   • Name: Enter a name of your choice; for example, PMDT.
   • URL: Enter the URL for the candidates registry: https://artifactory.prd.it.unity3d.com/artifactory/api/npm/upm-candidates.
   • Scope(s): Enter the scope of package name: com.unity.package-manager-doctools.
2. From the Package Manager window > My Registries drop-down menu, install Package Manager Doctools.

Once installed Package Manager Doctools appears in the packages list.