A Python toolbox and the tools within can be documented like any other geoprocessing tool.
There are different ways to edit the help of a Python toolbox or its tools.
- In the Catalog window or ArcCatalog:
- Right-click a tool or toolbox you created and click Item Description. This will open the Item Description window, displaying the Description page.
- Click the Edit button
.
- In the Search window:
When a tool or toolbox is found as the result of your search in the Search window, as described in A quick tour of finding tools, you can access its Description page as follows:
- Hover the pointer over the tool or toolbox name; a pop-up window appears with a link to Item Description at the bottom. Click that link to open the Item Description window, then click the Edit button .
- Click the summary line of the tool or toolbox found below its name to open the Item Description window, then click the Edit button .
- Hover the pointer over the tool or toolbox name; a pop-up window appears with a link to Item Description at the bottom. Click that link to open the Item Description window, then click the Edit button
For Python toolboxes, the documentation for the toolbox and tools are stored in .xml files that are associated with the toolbox and tools by name. The help for each tool will be stored in a separate .xml file.