Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Enable the build of the documentation without pyarrow built from source #35906

Closed
AlenkaF opened this issue Jun 5, 2023 · 0 comments · Fixed by #35907
Closed

[Docs] Enable the build of the documentation without pyarrow built from source #35906

AlenkaF opened this issue Jun 5, 2023 · 0 comments · Fixed by #35907

Comments

@AlenkaF
Copy link
Member

AlenkaF commented Jun 5, 2023

Describe the enhancement requested

We should enable the build of the documentation (all of it, only format section or only developers section) without having pyarrow built from source (that is without pyarrow or with pyarrow installed as a binary).

Connected to the work in #30627 and #35609.

Component(s)

Documentation

AlenkaF added a commit that referenced this issue Jun 21, 2023
…rrow installed (#35907)

### Rationale for this change

Ease the process of building the documentation for dev purposes.

### What changes are included in this PR?

`conf.py` is updated in a way to permit having pyarrow not installed (from source or as a binary).
In case pyarrow is not available:
- `docs/source/python` folder will be excluded from the build of the documentation
-  version of the documentation will be set to `'0.0.0-local-docs-build'`

I have tested the changes for cases when:
- pyarrow was built from source
- without pyarrow
- pyarrow was installed from PyPI, version 12.0.0

with building all of the docs and only format/developers sections.
* Closes: #35906

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
@AlenkaF AlenkaF added this to the 13.0.0 milestone Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant