Documentation Portal¶
Auto-generated Python documentation¶
The Documentation Portal serves as a centralized source of auto-generated Python documentation for custom code within Dataiku. It indexes Project Libraries and Global Shared Code, facilitating code discovery and reuse across the instance.
If multiple library sources contain a module or package with the same name, DSS resolves it using Python path order: the first matching module or package is used. For project libraries, this order is defined by the project library configuration (pythonPath in external-libraries.json).
Documentation Extraction¶
Documentation is generated using static analysis. This method examines the structure of each file independently without executing the code. Consequently, imports are not resolved to their source, and hyperlinks are not generated for objects defined in other files.
This approach ensures documentation is generated safely and reliably, even if the project’s environment dependencies are not currently installed.
Generation Frequency¶
The documentation is generated automatically during DSS instance startup. It is subsequently refreshed whenever a file within the Global Shared Code or Project Libraries is modified.
After code changes, updates are not immediate: the indexing job runs on a short cycle (30 seconds by default), then processing time is required. Depending on instance load and library size, updated documentation can take from a few seconds to a few minutes to appear.
Access¶
You can open the Documentation Portal from the DSS interface:
Application menu > Documentation Portal for the instance-wide view.
Python code recipes, Python webapps, Agent tool (Custom Python), and Agents & GenAI Models (Code Agent), where documentation is available in an embedded view.