Method GenerateOffline

GenerateOffline(PackageInfo, string, string)

Generate a static documentation site suitable for offline viewing.

By default, the documentation folders will be generated in /Users/USER_NAME/Library/Application Support/Unity/Editor/documentation/packages on Mac C:\Users\USER_NAME\AppData\Local\Unity\Editor\documentation\packages on Windows

Declaration

public string GenerateOffline(PackageInfo packageInfo, string version, string outputFolder = null)

Parameters

Type	Name	Description
PackageInfo	packageInfo	Information for the package to build documentation for, retrieved from the Editor's package manager api
string	version	Version in Semantic version format -- eg: 1.2.0
string	outputFolder	(Optional) Output folder where the doc site should be created.

Returns

Type	Description
string	A dump of the log for the build, or a warning message if nothing was generated