Skip to content

Add a clean python API reference to the documentation #4

@rahlk

Description

@rahlk

Is your feature request related to a problem? Please describe.
The current documentation lacks a clear and structured Python API reference, making it difficult for developers to understand available functions, classes, and modules. This can slow down development and increase the learning curve for new contributors or users.

Describe the solution you'd like
Integrate a clean, well-organized Python API reference into the documentation using MkDocs. This should include detailed docstrings, function signatures, class descriptions, and usage examples. Tools like mkdocstrings can be used to automatically generate API documentation directly from the source code.

Describe alternatives you've considered

  • Manually documenting the API, but this is time-consuming and prone to becoming outdated.
  • Relying on inline code comments alone, which doesn't provide a centralized, navigable reference for users.

Additional context
The API reference should follow consistent formatting and integrate seamlessly with the existing MkDocs setup. Suggested example: see kolena

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions