Skip to content

MINOR: [Docs] Mention that linuxdoc should be installed via pip - #48352

Merged
kou merged 1 commit into
apache:mainfrom
HyukjinKwon:fix-docs-guide
Dec 5, 2025
Merged

MINOR: [Docs] Mention that linuxdoc should be installed via pip#48352
kou merged 1 commit into
apache:mainfrom
HyukjinKwon:fix-docs-guide

Conversation

@HyukjinKwon

Copy link
Copy Markdown
Member

Rationale for this change

# We can't install linuxdoc by conda. We install linuxdoc by pip in
# ci/dockerfiles/conda-python-pandas.dockerfile.
# linuxdoc

Documentation build requires linuxdoc but it cannot be installed via Conda. Therefore, has to be documented properly for dev.

What changes are included in this PR?

This PR adds a note about linuxdoc that has to be installed via pip to successfully build documentation.

Are these changes tested?

Yes

Screenshot 2025-12-05 at 4 12 10 PM

Are there any user-facing changes?

No

@kou kou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 19650fe into apache:main Dec 5, 2025
7 checks passed
@kou kou removed the awaiting review Awaiting review label Dec 5, 2025
@github-actions github-actions Bot added the awaiting merge Awaiting merge label Dec 5, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 19650fe.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 7 possible false positives for unstable benchmarks that are known to sometimes produce them.

Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…he#48352)

### Rationale for this change

https://github.com/apache/arrow/blob/f0955f1b0019f4794bbc707eeefcb96eee856d1f/ci/conda_env_sphinx.txt#L24-L26

Documentation build requires `linuxdoc` but it cannot be installed via Conda. Therefore, has to be documented properly for dev.

### What changes are included in this PR?

This PR adds a note about `linuxdoc` that has to be installed via `pip` to successfully build documentation.

### Are these changes tested?

Yes

<img width="689" height="435" alt="Screenshot 2025-12-05 at 4 12 10 PM" src="https://github.com/user-attachments/assets/1595ea39-ade8-42ea-a6c1-b2fc662b583b" />

### Are there any user-facing changes?

No

Authored-by: Hyukjin Kwon <gurwls223@apache.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
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.

2 participants