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

[Python][Docs] Enable building documentation with pyarrow nightly builds #32383

Closed
asfimport opened this issue Jul 14, 2022 · 2 comments
Closed

Comments

@asfimport
Copy link
Collaborator

asfimport commented Jul 14, 2022

The instructions for building documentation describes needing pyarrow to successfully build the docs. It also highlights that certain optional pyarrow features must be enabled to successfully build:

Note that building the documentation may fail if your build of pyarrow is not sufficiently comprehensive. Portions of the Python API documentation will also not build without CUDA support having been built. 

"Sufficiently comprehensive" is relatively ambiguous, leaving users to repeat a sequence of steps to identify and resolve required elements:

  • Build C++

  • Build Python

  • Attempt to build docs

  • Evaluate missing features based on error messages

    This adds significant overhead to simply building docs, limiting accessibility for less experienced users to offer docs improvements.

    Rather than attempt to follow the steps above, I attempted to use a nightly pyarrow build to satisfy docs build requirements. This did not work, though, because nightly builds are not built with the options needed to build docs:
    {code:java}
    (base) todd@pop-os:~/arrow$ pushd docs
    make html
    popd
    ~/arrow/docs ~/arrow
    sphinx-build -b html -d _build/doctrees  -j8 source _build/html
    Running Sphinx v5.0.2
    WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English).
    making output directory... done
    [autosummary] generating autosummary for: c_glib/index.rst, cpp/api.rst, cpp/api/array.rst, cpp/api/async.rst, cpp/api/builder.rst, cpp/api/c_abi.rst, cpp/api/compute.rst, cpp/api/cuda.rst, cpp/api/dataset.rst, cpp/api/datatype.rst, ..., python/json.rst, python/memory.rst, python/numpy.rst, python/orc.rst, python/pandas.rst, python/parquet.rst, python/plasma.rst, python/timestamps.rst, r/index.rst, status.rst
    WARNING: [autosummary] failed to import pyarrow.compute.CumulativeSumOptions.
    Possible hints:

  • ModuleNotFoundError: No module named 'pyarrow.compute.CumulativeSumOptions'; 'pyarrow.compute' is not a package

  • AttributeError: module 'pyarrow.compute' has no attribute 'CumulativeSumOptions'

  • ImportError: 
    WARNING: [autosummary] failed to import pyarrow.compute.cumulative_sum.
    Possible hints:

  • ModuleNotFoundError: No module named 'pyarrow.compute.cumulative_sum'; 'pyarrow.compute' is not a package

  • ImportError: 

  • AttributeError: module 'pyarrow.compute' has no attribute 'cumulative_sum'
    WARNING: [autosummary] failed to import pyarrow.compute.cumulative_sum_checked.
    Possible hints:

  • ImportError: 

  • AttributeError: module 'pyarrow.compute' has no attribute 'cumulative_sum_checked'

  • ModuleNotFoundError: No module named 'pyarrow.compute.cumulative_sum_checked'; 'pyarrow.compute' is not a package
    WARNING: [autosummary] failed to import pyarrow.dataset.WrittenFile.
    Possible hints:

  • ModuleNotFoundError: No module named 'pyarrow.dataset.WrittenFile'; 'pyarrow.dataset' is not a package

  • ImportError: 

  • AttributeError: module 'pyarrow.dataset' has no attribute 'WrittenFile'Extension error (sphinx.ext.autosummary):
    Handler <function process_generate_options at 0x7f6f49ebe820> for event 'builder-inited' threw an exception (exception: no module named pyarrow.parquet.encryption)
    make: *** [Makefile:81: html] Error 2
    ~/arrow
    {code}
    Nightly builds should be made sufficient to build documentation.

Reporter: Todd Farmer / @toddfarmer

Related issues:

Note: This issue was originally created as ARROW-17076. Please see the migration documentation for further details.

@AlenkaF
Copy link
Member

AlenkaF commented Jun 26, 2023

Duplicate of #35906

@AlenkaF AlenkaF marked this as a duplicate of #35906 Jun 26, 2023
@AlenkaF
Copy link
Member

AlenkaF commented Jun 26, 2023

This issue was fixed with #35907

@AlenkaF AlenkaF closed this as completed Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants