Search Unity

Custom Documentation Links

Discussion in 'Package Manager' started by JakHussain, May 24, 2019.

  1. JakHussain

    JakHussain

    Joined:
    Oct 20, 2016
    Posts:
    105
    I've got a package I'm hosting on a verdaccio server and I'm using Docfx to generate a static website on gitlab for my manual and scripting API. Everything works but I want to edit the package.json so that the documentation link in the package manager window sends users to my documentation site and not to Unity's documentation site. Is this possible / in the roadmap? I can't find any details on this.
     
  2. bdovaz

    bdovaz

    Joined:
    Dec 10, 2011
    Posts:
    688
    Same problem here.
     
  3. Erothez

    Erothez

    Joined:
    May 27, 2015
    Posts:
    15
    `PackageInfo.cs` implies that you can do offline documentation with `Documentation~` etc. but that's only the URI to .md files, with the URL redirect being hardcoded atm.

    The current workaround, as it uses `SearchOption.TopDirectoryOnly`, link to that .md file which then has a link to the rest of the online docs.

    An old comment seems to imply it used to be editable:

    Code (CSharp):
    1. // Module package.json files contain a documentation url embedded in the description.
    2. // We parse that to have the "View Documentation" button direct to it, instead of showing
    3. // the link in the description text.
    But seems this is only for builtin modules?
     
    Last edited: May 25, 2019