Changelog

All notable changes to this package will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Note

The Add this version by name... links only work for the PMDT if you have set up a Scoped Registry as described in the Installation documentation.

[Unreleased]

[3.14.3-preview] - 2025-10-14

Changed

  • Adds a function to hide object elements from assistive technologies on the changelog page by setting the 'aria-hidden' attribute to 'true'. This improves accessibility by preventing unnecessary interaction with non-essential elements.

[3.14.2-preview] - 2025-10-14

Changed

  • Enhances accessibility by adding meaningful aria-label attributes to xref links, anchor links, and breadcrumb links. Ensures unique and context-specific labels for better screen reader support.

[3.14.1-preview] - 2025-10-06

Changed

  • Adds aria-label attributes to xref links with 3 or less character. This should apply rule-239 of the level access maintenance scan.

[3.14.0-preview] - 2025-09-24

Added

  • Support for including a Java API reference as part of the package docs. Note that your package is responsible for extracting JavaDoc comments into either DocFX intermediate Yaml format or markdown files before generating the package docs.

Fixed

  • Fixed problem that prevented the Script Reference from generating when the project's Player settings specified a product name.

[3.13.2-preview] - 2025-09-17

Changed

  • Sets the default document language and adds functionality to extract the language code from the URL and set it as the lang attribute on the HTML element.

[3.13.1-preview] - 2025-09-12

Changed

  • Updated template partials to use <span> tags instead of <a> tags for non-interactive elements, improving HTML semantics and accessibility compliance (addresses rule-1119 of level access maintenance scan).

[3.13.0-preview] - 2025-07-23

Changed

  • Always use Unity's built-in code project generation as the source for the C# project files used to generate documentation. Remove the UI and command line options for setting this since they are no longer needed.
  • Removed the Validate feature. This feature relied on the deprecated PVS package, which has started failing under Unity 6.3.

Fixed

  • File not found exceptions thrown when running under Unity 6.3. One of these exceptions was related to the PVS package. Another occurred when the option to Use built-in code project generation was not enabled.

[3.12.0-preview] - 2025-07-01

Added

[3.11.0-preview] - 2025-06-17

Added

  • Added tool for quickly finding undocumented APIs and other compilation-related issues. This tool compiles a package's code with the -doc option turned on. Warnings and errors are logged to the Unity console. Double-click a log entry to open the source code file at the line responsible for the error. Run the tool from the PMDT Tools menu. You must add PMDT_TOOLS to the Scripting Define Symbols of your project's Player Settings to enable this menu.

Fixed

  • Removed duplicates from the backup xrefmaps for older Unity versions. Unfortunately, DocFX does not allow specifying an order for xrefmap lookup, so duplicates could result in the wrong Unity version being linked to.

[3.10.1-preview] - 2025-05-19

Added

  • Added tool for finding assemblies in a project that are guarded by define constraints. The tool, List Assembly Define Constraints, enumerates all of the .asmdef assets in a project, including the project's packages, and logs any with Define Constraints to the Unity console. Run the tool from the PMDT Tools menu. You must add PMDT_TOOLS to the Scripting Define Symbols of your project's Player Settings to enable this menu.

Fixed

  • Fixed bug that allowed stale project files to be used when identifying source files to include in documentation generation. (This bug resulted in assemblies being included when guarded by a define constraint even when the required symbol was no longer defined.)

Known issues

  • Types in assemblies guarded by a define constraint are not included in the public generated docs. Use the List Assembly Define Constraints tool to identify assemblies that might be affected.

    Important

    Even though you can generate docs for these types locally by defining the symbol in the project settings, there is currently no way to define symbols used for define constraints for the package-docs-cli job that generates the public docs. (Adding symbols to pmdt-additional-preprocessors in the projectMetadata.json file does not work.) A workaround is to generate a Zipped Doc Build locally after defining the necessary symbols in a suitable project and upload the docs manually.

[3.10.0-preview] - 2025-03-25

Changed

  • Changed how we handle xrefs to the core Unity docs. Previously, we used xrefmaps of the version of Unity that is running this PMDT tool at the time of doc generation. (These xrefmaps were either built-in to the PMDT or, in recent versions of Unity, hosted alongside the online docs.) As of this change, we always use the "current" "LTS" version of Unity as the source of the xrefmap files when generating docs with the 20XX versions of Unity. The main consequence of this is that we will no longer generate package docs that link to obsolete versions of Unity. When generating docs with Unity 6+, we link to the corresponding version of Unity (in other words, 6000.0 for Unity 6.0, 6000.1 for Unity 6.1, and so on). We do have smaller, fallback xrefmaps to the Unity core docs that contain UIDs that existed in previous versions of Unity, but not in Unity 6. This allows us to still regenerate from older source without breaking these older links (which will resolve to the older core docs versions).

[3.9.3-preview] - 2025-03-12

Changed

  • aria-label describing the purpose of the link that zooms an image where a larger version is available.

[3.9.2-preview] - 2025-03-12

Changed

  • aria-label describing the purpose of the link that takes users to the home page when they click on the Unity logo.

[3.9.1-preview] - 2025-02-6

Added

  • Added keyboard navigation support for copy code button.

[3.9.0-preview] - 2025-01-23

Added

  • Copy button for code examples
  • Added examples of syntaxes for linking from API comments to manual pages using xrefs and uids.

Fixed

  • Fixed namespace links on API pages referencing non-existent parent namespace pages.

[3.8.1-preview] - 2025-01-15

Changed

  • Documentation updates.

[3.8.0-preview] - 2025-01-08

Added

Changed

  • Reorganized PMDT docs ToC slightly.

Fixed

  • Fixed DocFx config that set markdown engine to null.
  • Fixed DocFX config that set Mardig extension list to empty.
  • Removed extra padding added to highlighted search terms on a page.

[3.7.0-preview] - 2024-12-18

Changed

  • Rewrite projects that contain nested dependent projects to reference the source code files instead of the project. This change helps resolve links between dependent packages.
  • Added function to rewrite the Mermaid diagram syntax used in Github to that used by the base Mermaid.js library. This allows packages to display rendered Mermaid diagrams in both Github and the generated HTML pages.

[3.6.2-preview] - 2024-08-28

Changed

  • Made color of the text of hyperlinks inside a Tip or a Note darker.

[3.6.1-preview] - 2024-07-30

Changed

  • Default value of the Use built-in project generation option to false.

Fixed

  • Problem resolving some xref links when the Use built-in project generation option is enabled. While this option produces fewer compile errors in general -- which is useful when generating and testing docs locally -- the option also introduces a failure to resolve some properly constructed xref links. Because the default value of the option is now false, the option won't be used on the server when generating the docs for public consumption.

[3.6.0-preview] - 2024-07-15

Changed

  • Increased package dependencies:
    • "com.unity.package-validation-suite" to "0.73.0-preview",
    • "com.unity.nuget.newtonsoft-json" to "2.0.2",
    • "com.unity.sharp-zip-lib" to "1.3.8"

Fixed

  • Problem handling Unity 6 version number when using the Validate option. (Fixed by updating the version of the Package Validation Suite to one that contained this fix.)

[3.5.3-preview] - 2024-07-10

Changed

  • Changed labels of some options shown in the Package Manager.
  • Changed the default value of Use built-in code generation and Ignore MSBuild errors to true.

Added

[3.5.2-preview] - 2024-07-3

Fixed

  • Removed reference to polyfill in example markdown page.

[3.5.1-preview] - 2024-07-1

Fixed

  • Creates build directory if it does not already exist on Mac.
  • Update UnityEngine xrefmap for Unity 2023.1 to remove git conflict markers and incorrect entries from a bad merge.

Changed

  • In Unity 6, the core Unity manual now has UIDs assigned manually rather than generated based on the filename. (This was never a good system because the UID would change if the file name changed, which nullifies one of the benefits of a UID/xref system.) The default UIDs are based on the filename, but it is no longer guaranteed that the UID and filename will match in any way. The new, default UIDs use the form: um-kebap-case-filename. For example, The "Types of 2D primitive GameObjects" topic, in the 2DPrimitiveObjects.md file, has the UID um-2d-primitive-objects. It previously was assigned, 2DPrimitiveObjects. The um-style UIDs will not be backported to pre-Unity 6 versions. When the docs for a package are generated with Unity 6, a separate xrefmap file with the old UIDs is used to resolve links using the old UIDs. This is manually created, however, and could get out of date. Similarly, when generating package docs in older versions of Unity, a separate xrefmap file containing the um-style UIDs is used to resolve links. This is also created manually and could get out of date. The fix for these files getting out of date is to take the latest generated xrefmap files, add a baseURL field to the the file and commit it to the PMDT repo with the correct filename. These files are:

    • df~/unitymanual_xrefmap_213_um_uids.yml -- xrefmap for Unity 2021.3 containing um- UIDs. Use the Unity 6 manual xrefmap file as the basis when updating.
    • df~/unitymanual_xrefmap_223_um_uids.yml -- xrefmap for Unity 2022.3 containing um- UIDs. Use the Unity 6 manual xrefmap file as the basis when updating.
    • df~/unitymanual_xrefmap_u6_old_uids.yml -- xrefmap for Unity 6 containing old style UIDs without a prefix. Use the latest Unity 2022.3 xrefmap as the basis when updating.

[3.5.0-preview] - 2024-04-17

Added

  • Adds Javascript function to pages to replace package version numbers with the current metadata written to page header at doc generation time. Also adds a kharma link formatter to get proper kharma install link for a package. Refer to Variables for instructions.

[3.4.0-preview] - 2024-04-17

Added

  • Function to ALT+Doubleclick on a page element to get the xref string for referencing that element. The feature must be enabled when browsing the generated pages before it can be used. This is done with a URL parameter, xrefs=on. Refer to Get xrefs from a published page for instructions.

[3.3.1-preview] - 2024-04-16

Added

  • Added filter to suppress irrelevant messages in the Error Report. (Enable the Debug Doc Build option to include these messages.)
  • Add automatic links to the Changelog to open the Unity Editor "Add package by name" dialog with the package ID and version for each Changelog entry.

Fixed

  • Increased border around Unity logo

[3.3.0-preview] - 2024-03-01

Added

Fixed

  • Fixed ExpressionNotValidException caused by extra space in expression in Unity.PackageManagerDocTools.Editor.asmdef.

[3.2.3-preview] - 2024-02-15

Fixed

  • Error in previous release.

[3.2.2-preview] - 2024-02-15

Fixed

  • Build error due to DevelopmentBuild being removed from the AssemblyBuilderFlags enum.

[3.2.1-preview] - 2024-01-12

Fixed

  • Restored default memberLayout (samePage) and added backwards compatibility for deprecated useMemberPages setting. Reference.

[3.2.0-preview] - 2024-01-04

Changed

  • Made UnityEditor.PackageManager.DocumentationTools.UI.GlobalSettings public to allow Unity projects to configure documentation generation.

Fixed

  • WEBDOCS-1037 Redirect from index.html to manual/index.html in offline template.
  • WEBDOCS-1037 Correct Favicon & Logo in offline template.
  • WEBDOCS-1037 Copyright notice and (relevant) legal links in offline template.

[3.1.1-preview] - 2023-12-13

Fixed

  • WEBDOCS-1009 Batch mode syncs latest package metadata from repository before producing @latest redirection, and treats all 0.x.y packages as experimental when determining "latest".

[3.1.0-preview] - 2023-11-14

Changed

  • Removed comment from token.json for Unity Translate compatibility
  • Increased version of the Package Validation Suite package on which we depend to 0.61.0-preview.

Fixed

  • Fixed redirect code that prevented links to subpages in preview-status package docs from working when both a subfolder parameter and an anchor (#) tag are used.
  • Fixed CSS selector that identified images on a page that should receive the large image "zoom" treatment.
  • Fixed badly formatted comments in header template

[3.0.2-preview] - 2023-11-07

Added

  • Localization support for Trademarks and terms of use footer link text.

[3.0.1-preview] - 2023-10-26

Changed

  • Page footer is now compliant with the California Consumer Privacy Act.
  • Moved the "Generated by DocFX on ..." out of the footer and into the generator metadata in the header to save space

Fixed

  • Command line arguments in Batch Mode are now additive rather than definitive
  • Set a default path for pmdt_status.json file when running in batch mode
  • Include user-defined assemblies when using built-in code project generation
  • Fixed null reference exception in 2020.3 and 2019.4 configuring the UI

[3.0.0-preview] - 2023-08-24

Changed

  • Upgraded DocFX support to 2.70.0
  • DocFX is no longer included in this package and must be installed as a dotnet tool.
  • Code generation settings including additional preprocessor directives should be migrated from config.json to projectMetadata.json.

Added

  • Experimental support for built-in code project generation.
  • Ignore API documentation build errors option to suppress errors arising from using the new MSBuild version supplied by DocFX 2.70.0 and PMDT's default monolithic code project generation. These aren't "new" compile errors, the newer version of MSBuild is stricter by default than the older version. Using built-in code project generation avoids most of these new errors.
  • Export API Metadata option to export .NET API Docs YAML files for use in other tools.
  • An early preview of DocFX's new Modern template.
  • Various command line options for new and existing documentation generation options.

Removed

  • DocFX 2.58.9 binaries.
  • Mono binaries. DocFX is now shipped as a dotnet tool for Windows, MacOS and Linux so Mono is no longer required.
  • MadCap Flare project export.

Known Issues

[2.3.1-preview] - 2023-09-27

  • Fix WEBDOCS-751: Support anchors in Flare Tables of Contents.

[2.3.0-preview] - 2023-07-12

  • Add image comparison feature.
  • Added copyright to docs built with offline option.
  • Support including code snippets from the Samples folder. The PMDT copies Samples~ to Samples if it doesn't exist. This allows you to reference a snippet using the same path even though packing a package automatically adds the ~ character. You can add "renameSamplesFolder": false to the projectMetaData.json file to opt out of copying the folder.
  • Added project metadata flag to hide link to Script Ref in the title bar. Add "showScriptRef": false to the projectMetaData.json file to remove the link.

[2.2.0-preview] - 2023-05-12

  • Support for Mermaid diagrams

[2.1.1-preview] - 2023-03-30

  • Fix problem where enum members weren't sorted.
  • Fix problem where enum member value wasn't shown in table.
  • Move langword example comment to its own example class (for clarity).

[2.1.0-preview] - 2023-03-06

  • Expanded supported C# language keywords to include all of the ones listed on the Microsoft C# keywords page.
  • Revert the minimum supported version of Unity to 2019.4 (in use for Localization)
  • Restore the Flare project option (in use for Hexadocs)

[2.0.0-preview] - 2023-01-12

  • Increase the minimum supported version of Unity to 2020.3.
  • Removed Serve after Build option. To view locally generated docs, build offline docs or run a localhost web server. (You can run the command python -m http.server <port> in a terminal or command window to launch such a web server at port. Navigate to the directory containing the doc html files before running the command.)
  • Removed the Flare project options.
  • Removed the Find Doc Errors button. You can run this function, if desired, by calling the [LogDocCompileWarningsAndErrors](xref:UnityEditor.PackageManager.DocumentationTools.UI.Validator.LogDocCompileWarningsAndErrors(UnityEditor.PackageManager.PackageInfo,System.String) function from your own code. )
  • Suppresses deprecation warning for the AssemblyBuilder class.
  • Replaces the deprecated GenerateDocs function with the replacment GenerateDocsWithStatus.
  • Added workaround for UIDs for referencing constructor functions in the core Unity API. In markdown, use the form xref:Namespace.Class.ctor to link to a constructor. For APIs in packages, you must still use the form xref:Namespace.Class.#ctor (which doesn't work for the core API for unknown reasons).
  • Updated Unity xrefmap files.
  • Uses online Unity xrefmap files in Unity 2023.1 and above.

[1.13.4-preview] - 2022-12-03

  • Support use of '#' in anchor links through the @latest redirect mechanism. Links such as http://com.package.id@latest#anchor and http://com.package.id@latest?subfolder=/manual/page.html#anchor now work.

[1.13.3-preview] - 2022-11-18

Changed

  • Rolled DocFX version back from 2.59.4 to 2.58.9. It introduced a breaking change to plugin support which is preventing Flare export.

[1.13.2-preview] - 2022-11-07

Changed

  • Updated DocFX version from 2.58.9 to 2.59.4

[1.13.1-preview] - 2022-11-04

  • Updated Unity xrefmap files

Fixed

  • No longer include code files in the Script reference that are in folders ignored by Unity convention (see Special Folders) or which use excluded file names.
  • Improved ability to cancel doc generation job. Using the Cancel button on the progress bar will now cancel the job up until the point that DocFX is launched.

[1.13.0-preview] - 2022-08-03

Added

  • Debug option for batch builds, to enhance debugging of failed build jobs
  • Enabled the DocFX "newtab" setting by default. Any links to external web hosts are opened in a new tab. Projects can override this default behaviour by adding the "_enableNewTab": false to the projectMetadata.json file in Documentation. See Per-project metadata for more information.

Fixed

  • Preserve doc-fx log when subsequent operations fail Build
  • Fix the ability to use a custom index page for the Script reference section (broken in 1.12.6-preview).

Changed

  • Upgraded package validation suite to 0.26.0-preview to resolve dependency collision with DOTS packages depending on com.unity.nuget.mono-cecil@1.11.4

[1.12.7-preview] - 2022-07-08

Fixed

  • Report status of docs generation to a file, so that upstream pipelines can fail when an exception is handled by package manager doc tools.

[1.12.6-preview] - 2022-04-12

  • Improved error messages related to downloading remote package metadata. Since this metadata isn't always available, the issue is reported as a warning rather than an error.
  • Update xrefmap files to be current as of the Unty 2021.3 LTS release.

[1.12.5-preview] - 2022-03-11

Fixed

  • Fixed the link generated for <see langword="out"/> so it goes to the out parameter modifier page instead of the unsafe page.

[1.12.4-preview] - 2022-02-08

Fixed

  • Fixes Flare project generation for documentation containing inline javascript EG: com.unity.lobbby@1.0.0

[1.12.3-preview] - 2022-02-08

  • Correct path to DocFX and Mono zip files.

[1.12.2-preview] - 2022-02-04

  • Added warning messages when System.IO errors occur and the paths involved exceed to 260 character Windows path length limit.
  • Moved the DocFX template folders to shorten the paths within this package.

[1.12.1-preview] - 2021-12-20

Added

  • UI option to generate a spreadsheet from the validation report

[1.11.1-preview] - 2021-12-16

Added

  • UI option to generate the package docs with a static TOC for offline browsing to support NDA documentation.
  • functionality to build a Flare Project directly as an experimental feature in the UI (Windows only)
  • appropriate test coverage to FlarePostProcessor at unit and integration level

Changed

  • "missing System.Runtime assembly" exception when building Flare project on Windows
  • broken links in Tables of Contents for topics that Link to content with spaces in the title
  • Mac build error caused by update to DocFX 2:.58.9, which needed an updated Mono for Mac (6.12)

[1.11.2-preview] - 2022-01-21

  • Update XrefMap files for Unity Manual and Script Reference
  • Remove xrefmaps for now unsupported, non-LTS versions of Unity
  • Add xrefmaps for Unity 2022.1
  • Add lists of uids to use to make links to the core Unity Manual and Script Reference to documentation.

[1.10.0-preview] - 2021-11-24

  • Update to DocFX 2.58.9
  • Add feature to find and log potentially missing API docs and other related compile warnings and errors

[1.9.5-preview] - 2021-10-13

  • Changed the navbar Unity brand logo to the new brand logo
  • Add support for specifying additional xrefmaps
  • Check localhost:80 for an xrefmap file if the specified version doesn't exist on the web server

[1.9.4-preview] - 2021-09-10

  • Fixed an issue with the language switcher code that linked users to localised docs @latest if a version of docs exist on the server but not the same version the user is currently on. Not all localised docs have the version that is considered latest for each package so instead the user is sent to the highest major.minor version that exists on the server.

[1.9.3-preview] - 2021-09-02

  • Modified the frontend version switcher code to use the pre-built versions.json file in the packages metadata directory on the docs.hq server to populate with versions available

[1.9.2-preview] - 2021-08-09

  • Modified the frontend language switcher code to now request and use the pre-built versions.json file in the packages metadata directory on the docs.hq server

[1.9.1-preview] - 2021-05-14

  • Added a dependency on the SharpZipLib package: com.unity.sharp-zip-lib
  • Implemented a toggle in the packman window that allows users to generate a zip alongside the package docs with the correct hash name for uploading to the PackageDaemon

[1.9.0-preview] - 2021-03-22

  • Added GenerateEx, that returns the folder name where documentation is contained.
  • DocFx .csproj now explicitly depends on .NET framework v4.7.1.
    • If you're running under Windows you need to have .NET SDK v4.7.1 installed (comes bundled with Visual Studio install, so if you have Visual Studio you most likely have it already installed).
    • If you're running under Linux/macOS no changes are necessary.
  • Fix toc conversion so that links using xref: can be included in the TableOfContents.md file
  • Updated xrefmap files for Unity 2020.3 (note that the 2021.2 xrefmap is not available for Manual links, only the Script Reference)

[1.8.0-preview] - 2021-02-04

  • Upgrade dependency on the Package Validation Suite package to get fix for a bug in which using CDATA in a comment caused an exception during validation.

[1.7.1-preview] - 2021-01-14

  • Remove * characters from link titles xrefmap files to avoid unexpected character errors

[1.7.0-preview] - 2020-12-03

  • Return the build log string from Documentation.Generate function.
  • Avoid copying ignored folders

[1.6.1-preview.2] - 2020-09-28

  • Include the Linux Mono archive that was accidentally omitted from the previous release.

[1.6.1-preview] - 2020-09-25

  • Added support for package documentation generation on Linux

[1.6.0-preview] - 2020-09-23

  • Add support for separating API members on their own pages. This featrue is opt-in. Add a file named projectMetadata.json to the Documentation~ folder containing the JSON statement: {"useMemberPages": true}.
  • Fixed bug that prevented classes in the global namespace from appearing in the script reference. Hint: use filter.yml to hide test classes (or put them in a namespace).
  • Fixed bug in which enum values were alphabetically sorted. Now enum values are sorted by value. The value is also displayed.

[1.5.1-preview] - 2020-09-08

  • Added support for the DOCTOOLS_DESTINATION environment variable which overrides the DestinationPath variable (see ./Editor/Sources/Services/Doc/GlobalSettings.cs).

[1.5.0-preview.2] - 2020-09-01

  • Fixed version selector for localised docs (links were formatted incorrectly resulting in broken links)

[1.5.0-preview.1] - 2020-08-25

  • Added support for linking to C# keywords (like null and async) with <see langword="keyword"> elements. Previously these were just rendered as normal text in the html output.

[1.4.0-preview.1] - 2020-08-18

  • Added support for placing markdown fragments in Documentation~/snippets. These fragments can be included by another markdown file, but do not become html files themselves.

[1.3.0-preview.1] - 2020-07-07

  • Add ScriptableAsset object to allow in-Editor batch doc generation.
  • Fixed sorting of versions in the HTML version selector control
  • Added minimum Unity version to HTML version selector text

[1.2.1-preview.1] - 2020-06-18

  • Fix bug introduced in 1.2.0 in which markdown files in subfolders under Documentation~ were ignored.
  • Added support for linking to toc.yml files in subfolders from TableOFContents.md.
  • Added documentation about nesting content in the TOC.
  • Added xrefmaps for Unity 2019.4
  • Added methods, fields, and properties to the Unity xrefmaps.

Known Issues

  • Not all Unity APIs can be crossreferenced via the xrefmaps. (The mapping of Comment ID to URL in the published docs is not always predictable. Adding support for the remaining types is ongoing.)
  • Cross-references to Unity docs does not always work. A workaround is to use the Assets > Open C# Project menu command in the Unity Editor before generating the docs. This seems to create a working project file with the correct library references.

[1.2.0-preview.1] - 2020-05-27

  • Refactored doc generation code to better resolve types in external assemblies
  • Some type links to other packages now work; all should list namespace if no link is available
  • Files in Documentation~ are no longer moved to a different relative location before doc generation. This is a potentially breaking change if file links assumed the old file structure. Including code samples defined in a region in a C# file inside a Manual markdown file is one place such breakage could occur. To correct this, remove the lowercase package folder in the path. Including a code sample in the XML comment of another C# file is unaffected by this change.
  • Warnings and errors are now always logged to a text file under Logs/DocToolReports in the project folder. View the report using the View Error Report button.
  • Added a Validate option, which runs the Package Validation Suite and includes its report in the Doc Tool Report. This shows missing API docs. It also creates a dependency on the Package Validation Suite package.
  • Added a Debug Doc Build option, which replaces the Verbose option.
  • Added batch generation to perform doc builds using Unity command line arguments.
    • Added support for optional api_index.md, which allows you to write content for the landing page of the Script Reference section.
  • Added version switcher feature
  • Changed header background colour to true black (#000)
  • Added metadata download feature on generating documentation
  • Moved breadcrumbs to main content area
  • Fixed some broken CSS (a rogue hashtag)
  • Added bold fonts to Roboto import for Mac users

[1.1.1-preview.5] - 2019-09-23

  • Updated the Google Tag Manager code
  • Changed default _apptitle setting to PACKAGE DISPLAY NAME | VERSION
  • Added persistant table of contents filtering

[1.1.1-preview.4] - 2019-08-29

  • Enable hyperlinks to the .NET System class documentation in script reference using the Microsoft Cross reference service.
  • Add per-project metadata support
  • Changed default _apptitle setting to "Unity Documentation"

[1.1.1-preview.3] - 2019-08-22

  • Updated default filter.yml to not exclude ObsoleteAttribute

[1.1.1-preview.2] - 2019-08-13

  • Added custom filter.yml documentation
  • Updated link colors to match Unity main style

[1.1.1-preview.1] - 2019-06-19

  • Adds preprocessor directives capability
  • Fixed System.InvalidOperationException: Sequence contains no elements error when generating without a manual

[1.1.0-preview.1] - 2019-05-13

  • Upgrade doctools for newer visual element styles
  • Fixed generate button taking no height

[1.0.0-preview.35] - 2019-05-02

  • Fixed filter.yml issue on windows

[1.0.0-preview.34] - 2019-05-01

  • Stopped building tiny runtime docs

[1.0.0-preview.33] - 2019-04-15

  • Updated copyright years

[1.0.0-preview.32] - 2019-03-26

  • Updated ads redirect for v3.0

[1.0.0-preview.31] - 2019-03-21

  • Fixed mono bin folder on mac

[1.0.0-preview.30] - 2019-03-18

  • Fixed verbose logging on windows

[1.0.0-preview.29] - 2019-03-16

  • Fixed mono on mac

[1.0.0-preview.28] - 2019-03-16

  • Adds serve feedback in verbose mode

[1.0.0-preview.27] - 2019-03-16

  • Fixes mono usage

[1.0.0-preview.26] - 2019-03-13

  • Fixed doc generation with C# 7.2 features like in
  • Removed documentation with members with the Obsolete attribute
  • Fixed links across namespaces
  • Added ability to add an overriding filter.yml inside the Documentation~ folder
  • Adds verbose mode for debugging when in developer mode

[1.0.0-preview.25] - 2019-02-20

  • Fixed header breaking correctly per section

[1.0.0-preview.24] - 2019-02-20

  • Fixed header breaking at any letter

[1.0.0-preview.23] - 2019-12-02

  • Fixed version conversion to support different CultureInfos
  • Removed cluttering in pages by filtering out System. inherited members

[1.0.0-preview.22] - 2019-01-01

  • Update redirection rules for package online documentations
  • Fix @latest doc generation for older packages

[1.0.0-preview.21] - 2018-12-11

  • Changed runtime folder name to rt for Tiny

[1.0.0-preview.20] - 2018-11-26

  • Fixes Runtime API section generation for Tiny package
  • Adds ability to use ?preview=1 to @latest page to link to latest preview version

[1.0.0-preview.19] - 2018-11-22

  • Create a Runtime API section for Tiny package

[1.0.0-preview.18] - 2018-11-06

  • Fixed button text

[1.0.0-preview.17] - 2018-11-01

  • Support UIElement out of experimental

[1.0.0-preview.16] - 2018-10-31

  • Show doctools on built in packages

[1.0.0-preview.15] - 2018-10-23

  • Fixed blockquote font size

[1.0.0-preview.14] - 2018-10-19

  • Fixed standardevents redirect url

[1.0.0-preview.13] - 2018-10-19

  • Modified analytics behavior on later versions

[1.0.0-preview.12] - 2018-08-20

  • Fixed indent on table of content

[1.0.0-preview.11] - 2018-08-17

  • Fixed site generation while not in developer mode

[1.0.0-preview.10] - 2018-05-17

  • Fixed table of content with large decreasing indents

[1.0.0-preview.8] - 2018-05-17

  • Fixed null pointer error when installing this package while Package Manager UI is open

[1.0.0-preview.7] - 2018-04-19

  • Added documentation
  • Added ability to have a table of content for user manual
  • Added a license section

[0.5.2] - 2018-04-10

  • Removed internal menu

[0.5.1] - 2018-04-03

  • Fixed readonly error on windows when generating documentation

[0.5.0] - 2018-02-13

  • Add Generate Documentation to Package Manager UI.

[0.3.0] - 2018-02-09

  • Adds the public void GenerateRedirect(string packageName, string latestVersionId, string outputFolder = null) API to allow building the package@latest redirect site.

[0.1.0] - 2018-02-09

This is the first release of Unity Package Manager Doctools.