Document Python Toolboxes (.pyt) in Source Code

Idea created by sgonzalez_bha on Jul 11, 2018
    Reviewed
    Score10
    • CleversonMachado

    I'm working on re-developing some custom ArcMap toolboxes with the new Python Toolbox (.pyt) format.

     

    Overall, the functionality is much better than the standard ArcMap Toolboxes (.tbx) because most of the functionality is embedded in the source code, and not in any binary data as with .tbx files.

     

    That said, is there any way to add the documentation/help for the tool and each parameter within the source code?

     

    Currently, the only way I know how to edit the help files is by editing the Item Description, but feel it would be a greater benefit to include within the .pyt code itself.

     

    Is this possible? Or are there currently any work-arounds to achieve this?