Skip to content

GH-47685: [Docs][Python] Add nested grouping to Python docs TOC#49557

Closed
Daedalus-Icarus wants to merge 1 commit into
apache:mainfrom
Daedalus-Icarus:Docs/issue-47685
Closed

GH-47685: [Docs][Python] Add nested grouping to Python docs TOC#49557
Daedalus-Icarus wants to merge 1 commit into
apache:mainfrom
Daedalus-Icarus:Docs/issue-47685

Conversation

@Daedalus-Icarus

@Daedalus-Icarus Daedalus-Icarus commented Mar 19, 2026

Copy link
Copy Markdown

Rationale for this change

The left-hand sidebar menu for the Python docs lists 22+ entries in a flat structure, making it hard to skim and navigate. The C++ docs already use nested toctree groupings (Getting Started, User Guide, etc.) which makes the sidebar much more scannable. This was requested in #47685.

Closes #47685

What changes are included in this PR?

  • Created 5 new intermediate grouping pages that organize the flat toctree into logical sections:
    • Getting Started: install, getstarted
    • Data and Compute: data, compute, memory, timestamps
    • File Formats and I/O: ipc, filesystems, csv, feather, json, orc, parquet, dataset, flight
    • Data Interchange: numpy, pandas, interchange_protocol, dlpack, extending_types
    • Reference: env_vars, api
  • Updated index.rst to reference the grouping pages and set maxdepth: 3 so the sidebar shows the nested structure
  • The existing integration.rst and getting_involved entries are reused as-is

Are these changes tested?

Documentation-only change. Can be verified by building the docs with Sphinx.

Are there any user-facing changes?

Yes — the Python docs sidebar navigation will show grouped sections instead of a flat list, improving discoverability.

@github-actions

Copy link
Copy Markdown

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

See also:

@Daedalus-Icarus

Copy link
Copy Markdown
Author

@AlenkaF Could you please review this PR and share feedback?

@Daedalus-Icarus Daedalus-Icarus changed the title Add nested toctree grouping to top-level Python docs GH-47685: [Docs][Python] Add nested grouping to Python docs TOC Mar 19, 2026
@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #47685 has been automatically assigned in GitHub to PR creator.

@Daedalus-Icarus

Copy link
Copy Markdown
Author

@AlenkaF any progress on this PR? when are you available to review this?

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #47685 has been automatically assigned in GitHub to PR creator.

@Daedalus-Icarus

Copy link
Copy Markdown
Author

Hey @AlenkaF. please review this and merge. I am waiting for your response

@Daedalus-Icarus

Copy link
Copy Markdown
Author

@AlenkaF @raulcd Please review this too

@raulcd

raulcd commented Mar 25, 2026

Copy link
Copy Markdown
Member

@Desel72 thank you very much for your PRs. We truly appreciate when people takes the time to contribute and help make the project better.
I wanted to point out that your messages are coming of as slightly rude, it is ok to ping a maintainer to review your PRs but this:
"please review this and merge. I am waiting for your response" comes across as demanding.
The maintenance of the project requires a lot of time and effort and some of the contributors take a lot of their free time to help. We juggle a lot of priorities and a small docs improvement, while still takes our time might not be on top of our review queue. Could you be mindful of that when posting a message?

I got the same feeling when reviewing this other PR:

@Daedalus-Icarus

Copy link
Copy Markdown
Author

Thank you for the feedback, and I apologize if my messages came across as rude. That wasn’t my intention. I really appreciate the time maintainers spend on reviews, and I’ll be more careful with my wording going forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs][Python] Add more levels of nesting to top-level Python docs

2 participants