Select to view content in your preferred language

Document Python Toolboxes (.pyt) in Source Code

3853
11
07-11-2018 12:35 PM
Status: Open
Labels (1)
StevenGonzalez1
Occasional Contributor

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?

11 Comments
AlfredBaldenweck

Yes, PLEASE.

(I think there may be another Idea out for this out there but I can't find it.)

The XMLs are such a pain to deal with. Copying them over with the toolbox, etc. It'd be one thing if we could place them in another folder or something; for each PYT I make, it gets its own folder, and within that, I sometimes have another folder or two for project-specific modules I've downloaded or for template files, etc. 

But having like 10 XMLs floating around is a pain.

I appreciate being able to format the text and stuff for metadata, and I appreciate that the XMLs probably make it easier to switch between metadata styles, but PLEASE let us just set parameter and tool and toolbox metadata as part of each class's properties. I'd gladly trade formatting for that.