Installation

Prerequisites

To use this version of Unity Package Manager Doc Tools, you must:

• Install version 2019.4 or later of the Unity Editor.
• Install DocFX.

Installing DocFX

Important

Starting from PMDT 3.0.0 DocFX isn't included and you must install it as a dotnet tool

If you don't install the recommended version of DocFX 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 from https://dotnet.microsoft.com/en-us/download/dotnet/ (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)

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 macOS 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.