Skip to content

Commit 19650fe

Browse files
authored
MINOR: [Docs] Mention that linuxdoc should be installed via pip (apache#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 <[email protected]> Signed-off-by: Sutou Kouhei <[email protected]>
1 parent b10386e commit 19650fe

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/source/developers/documentation.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ If you're using Conda, the required software can be installed in a single line:
3232
3333
conda install -c conda-forge --file=arrow/ci/conda_env_sphinx.txt
3434
35+
.. note::
36+
37+
``linuxdoc`` cannot be installed by Conda. It has to be installed via pip separately.
38+
3539
Otherwise, you'll first need to install `Doxygen <http://www.doxygen.nl/>`_
3640
yourself (for example from your distribution's official repositories, if
3741
using Linux). Then you can install the Python-based requirements with the

0 commit comments

Comments
 (0)