This issue tracks the addition of clear and structured docstrings to the public API of the Hera toolkit system.
The goal is to document what each user-facing function does, including its purpose, inputs, outputs, and expected behavior, so that:
Developers can understand and use the API more easily.
Existing Sphinx infrastructure can automatically generate accurate API documentation.
The current and future codebase has a consistent documentation standard.
The initial focus is on core entry points such as ToolkitHome and abstractToolkit, covering only user-facing methods. Internal helpers and private logic are intentionally excluded at this stage.
This issue is part of a larger effort to validate and (re)enable Sphinx-based API documentation for the entire system, with future issues expected to expand coverage.
This issue tracks the addition of clear and structured docstrings to the public API of the Hera toolkit system.
The goal is to document what each user-facing function does, including its purpose, inputs, outputs, and expected behavior, so that:
Developers can understand and use the API more easily.
Existing Sphinx infrastructure can automatically generate accurate API documentation.
The current and future codebase has a consistent documentation standard.
The initial focus is on core entry points such as ToolkitHome and abstractToolkit, covering only user-facing methods. Internal helpers and private logic are intentionally excluded at this stage.
This issue is part of a larger effort to validate and (re)enable Sphinx-based API documentation for the entire system, with future issues expected to expand coverage.