GH-47686: [Docs][Python] Split the Python Parquet docs into separate items#50419
GH-47686: [Docs][Python] Split the Python Parquet docs into separate items#50419AlenkaF wants to merge 9 commits into
Conversation
|
@github-actions crossbow submit preview-docs |
|
Revision: 156850c Submitted crossbow builds: ursacomputing/crossbow @ actions-937dad9db2
|
|
I have used Claude for suggesting the split of pyarrow parquet page and to look through the code and the git log history for any features/changes that might be missing from the docs. From what was suggested I continued with the work on my own. I have split the changes in different commits so the change will be easier to review (due to the docs split, the change is bigger than it really is). commit 1: restructure of the content, no content changes @thisisnic, do you mind having a look? Rendered docs are available here: https://s3.amazonaws.com/arrow-data/pr_docs/50419/python/parquet/index.html |
There was a problem hiding this comment.
Pull request overview
Splits the PyArrow Parquet user-guide documentation into multiple focused pages to improve navigability and enable incremental maintenance, aligning with the broader Python docs revision effort.
Changes:
- Replaces the single large Parquet guide page with a section index plus dedicated subpages (single-file IO, datasets, type handling, encryption).
- Updates the Python docs toctree to point at the new Parquet section entry point.
- Adds/relocates some additional Parquet-related content during the split (e.g., content-defined chunking).
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/source/python/parquet/parquet.rst | New “single files” Parquet IO page (read/write, metadata, filtering, etc.). |
| docs/source/python/parquet/parquet_type_handling.rst | New page for Parquet read/write type-handling options. |
| docs/source/python/parquet/parquet_datasets.rst | New page for partitioned datasets / multi-file Parquet usage. |
| docs/source/python/parquet/parquet_encryption.rst | New page for Parquet modular encryption docs. |
| docs/source/python/parquet/index.rst | New Parquet section landing page with toctrees to subpages. |
| docs/source/python/parquet.rst | Removes the previous monolithic Parquet documentation page. |
| docs/source/python/index.rst | Updates the Python guide toctree to reference the new Parquet section entry. |
| Multiple Parquet files constitute a Parquet *dataset*. These may present in a | ||
| number of ways: |
| (when writing version 1.0 Parquet files), the nanoseconds will be cast to | ||
| microseconds ('us'). | ||
|
|
||
| In addition, We provide the ``coerce_timestamps`` option to allow you to select |
| Key Management System (KMS), deployed in the user's organization. Using Parquet | ||
| encryption requires implementation of a client class for the KMS server. | ||
| Any KmsClient implementation should implement the informal interface | ||
| defined by :class:`pyarrow.parquet.encryption.KmsClient` as following: |
|
|
||
| >>> crypto_factory = pe.CryptoFactory(kms_client_factory) | ||
|
|
||
| An :download:`example <../../../python/examples/parquet_encryption/sample_vault_kms_client.py>` |
| timestamps | ||
| orc | ||
| parquet/index | ||
| dataset |
Rationale for this change
The current parquet section is one-page and covering lots of topics. As per #46601 the parquet section is most visited and would therefore need a bit of maintenance/content update.
What changes are included in this PR?
Are these changes tested?
Via the docs preview
Are there any user-facing changes?
No