docs: Ensure table of contents covers methods of Python classes
- Dominant language
- Rust
- Stars
- 503
- Forks
- 61
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 91
Description
As reported on Discord, it's difficult to scan the methods of a `DataFrame` in our docs because the table of contents only covers the top level components (i.e., the class name or top level module function name).
https://sedona.apache.org/sedonadb/latest/reference/python/#sedonadb.dataframe.DataFrame
It would be nice if we could extend the table of contents so that it includes methods (at least when that section is active), or perhaps we need to split up our docs pages so there's more than one page for all of the SedonaDB Python bindings!
Contributor guide
Research direction
Start at the linked sedonadb.dataframe.DataFrame reference page and inspect how its current table of contents is generated. Confirm the intended scope with the existing documentation structure; done means the active DataFrame section exposes its methods in the table of contents, or the page is split if that approach is chosen.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100