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

GH-35403: [Docs] Support sphinx 6 for building the docs #36296

Merged
merged 9 commits into from
Jul 6, 2023
Merged
4 changes: 3 additions & 1 deletion ci/conda_env_sphinx.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ doxygen
ipython
numpydoc
pydata-sphinx-theme==0.8
sphinx-autobuild
sphinx-design
sphinx>=4.2,<6
sphinx-copybutton
sphinxcontrib-jquery
sphinx==6.2
# Requirement for doctest-cython
pytest-cython
pandas
2 changes: 2 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ cpp-live:

.PHONY: python
python:
# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
python -m pip install ../python --quiet --no-dependencies
AlenkaF marked this conversation as resolved.
Show resolved Hide resolved
$(SPHINXBUILD) -b html $(SPHINXOPTS) -c $(SOURCEDIR) $(SOURCEDIR)/python $(BUILDDIR)/html/python
@echo
@echo "Build finished. The HTML files are in $(BUILDDIR)/html/python"
Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ pydata-sphinx-theme==0.8
sphinx-autobuild
sphinx-design
sphinx-copybutton
sphinx>=4.2,<6
sphinxcontrib-jquery
sphinx==6.2
pandas
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@
'IPython.sphinxext.ipython_console_highlighting',
'IPython.sphinxext.ipython_directive',
'numpydoc',
"sphinxcontrib.jquery",
'sphinx_design',
'sphinx_copybutton',
'sphinx.ext.autodoc',
Expand Down
1 change: 1 addition & 0 deletions docs/source/cpp/build_system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ This minimal ``CMakeLists.txt`` file compiles a ``my_example.cc`` source
file into an executable linked with the Arrow C++ shared library:

.. code-block:: cmake

cmake_minimum_required(VERSION 3.16)

project(MyExample)
Expand Down
8 changes: 8 additions & 0 deletions docs/source/developers/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,14 @@ These two steps are mandatory and must be executed in order.
not sufficiently comprehensive. Portions of the Python API documentation
will also not build without CUDA support having been built.

.. note::

If you are working on the Python documentation and are building the documentation
with ``pyarrow`` build from source on macOS Monterey, Python section of the
documentation might not be included in the ``_build/html`` when using the
``make html`` command. In this case use ``make python`` to only build the
python part of the documentation.

After these steps are completed, the documentation is rendered in HTML
format in ``arrow/docs/_build/html``. In particular, you can point your browser
at ``arrow/docs/_build/html/index.html`` to read the docs and review any changes
Expand Down
2 changes: 1 addition & 1 deletion docs/source/developers/java/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ CMake

- To build all JNI libraries (MacOS / Linux) except the JNI C Data Interface library:

.. code-block::
.. code-block:: text
AlenkaF marked this conversation as resolved.
Show resolved Hide resolved

$ cd arrow
$ brew bundle --file=cpp/Brewfile
Expand Down
6 changes: 3 additions & 3 deletions docs/source/format/CDeviceDataInterface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ has the following fields:
data.

.. seealso::
The :ref:`synchronization event types <_c-device-data-interface-event-types>`
The :ref:`synchronization event types <c-device-data-interface-event-types>`
section below.

.. c:member:: int64_t ArrowDeviceArray.reserved[3]
Expand Down Expand Up @@ -563,7 +563,7 @@ streaming source of Arrow arrays. It has the following fields:
.. c:member:: ArrowDeviceType device_type

*Mandatory.* The device type that this stream produces data on. All
``ArrowDeviceArray``s that are produced by this stream should have the
``ArrowDeviceArray`` s that are produced by this stream should have the
same device type as is set here. This is a convenience for the consumer
to not have to check every array that is retrieved and instead allows
higher-level coding constructs for streams.
Expand Down Expand Up @@ -675,7 +675,7 @@ is frozen. This means that the ``ArrowDeviceArray`` structure definition
should not change in any way -- including adding new members.

Backwards-compatible changes are allowed, for example new macro values for
:c:typedef:`ArrowDeviceType` or converting the reserved 24 bytes into a
:c:type:`ArrowDeviceType` or converting the reserved 24 bytes into a
different type/member without changing the size of the structure.

Any incompatible changes should be part of a new specification, for example
Expand Down