Skip to content

Add a dataframe.rst for #1100 #1101

Open
@kosiew

Description

@kosiew

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

I'm trying to document the newly added HTML formatting features for DataFusion DataFrames in Python (introduced in #1100). Currently, there's no dedicated documentation page (e.g., dataframe.rst) that outlines the DataFrame API, usage examples, or details about how HTML rendering works in Jupyter environments. This makes it harder for users to discover and leverage these features.

Describe the solution you'd like

Add a dataframe.rst file to the Python API documentation that includes:

  • An overview of the DataFrame API
  • Explanation and usage examples for _repr_html_ rendering
  • How to configure HTML rendering using configure_formatter()
  • Examples of using custom style providers and formatters
  • How to reset or globally manage formatting styles

Describe alternatives you've considered

  • Embedding limited information in existing pages like index.rst or session.rst, but this would not provide a clean or discoverable structure.
  • Relying solely on docstrings or tests, which is not user-friendly for new users.

Additional context

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