Loading documentation of Package installed in any directory

Question

Installing Package into $UserBaseDirectory or $BaseDirectory means automatic loading of the documentation (after calling the Package).

However, when I installed a Package into different directory (the directory is add to the $Path) the documentation is not loaded after calling the Package using Needs.

Any idea how to solve this issue?

Add documentation extension to paclet.m file, should work. And the directory // PacletDirectoryAdd. — Kuba, Mar 24 '17 at 15:45
Analogously to http://mathematica.stackexchange.com/a/120976/5478 for more info search pacletinfo.m documentation project here. — Kuba, Mar 24 '17 at 15:59
@Kuba, I see. I am using Workbench but I will look at your link and work on the pacletinfo.m itself. Thanks — Basheer Algohi, Mar 24 '17 at 16:02
I used this package. In addition to help in creating documentation, there are functions for installing documentation in the system https://github.com/yurkan/userhelp — Kirill Belov, Mar 24 '17 at 19:47

score 3 · Accepted Answer · answered Mar 24 '17 at 16:51

3

Add the directory containing the package directory to the paclet path.

PacletDirectoryAdd["/dir/to/my/pack"]

assuming that PacletInfo.m is contained within /dir/to/my/pack/PackageName.

This is not permanent. It lasts only until the end of the session.

answered Mar 24 '17 at 16:51

Szabolcs

234,956
30
623
1,263

One could put this in init.m if permanence is wanted, no? – J. M.'s missing motivation Mar 24 '17 at 16:59
@J.M. That would be the thing to try, but I do not know if: (1) there's a better way (2) PacletDirectoryAdd is safe to use during initialization. – Szabolcs Mar 24 '17 at 18:55
@J.M. I rather add this line before BeginPackage so that it is added only when it is loaded. Not the best way though. – Kuba Mar 24 '17 at 21:14

Loading documentation of Package installed in any directory

1 Answers1