mirror of
https://github.com/apache/arrow.git
synced 2026-10-29 09:05:47 +08:00
Bryce Mecum
0f7e9af437
### What changes are included in this PR? This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in https://github.com/apache/arrow/pull/40006): `trailing-whitespace` and `missing-final-newline`. This PR also fixes the individual issues covered by the new tooling. ### Are these changes tested? Yes, though manually. I tested this works by running `archery lint --docs` and `pre-commit` without and without changes that should get caught by the rules. It works as expected. ### Are there any user-facing changes? Yes, 1. Developers that use pre-commit hooks will see a change in behavior when they modify docs 2. Developers using archery will see a new --docs option in `archery lint` 3. Developers working on the docs may see CI failures related to the new checks * Closes: #39990 * GitHub Issue: #39990 Authored-by: Bryce Mecum <petridish@gmail.com> Signed-off-by: Bryce Mecum <petridish@gmail.com>
47 lines
1.8 KiB
ReStructuredText
47 lines
1.8 KiB
ReStructuredText
.. Licensed to the Apache Software Foundation (ASF) under one
|
|
.. or more contributor license agreements. See the NOTICE file
|
|
.. distributed with this work for additional information
|
|
.. regarding copyright ownership. The ASF licenses this file
|
|
.. to you under the Apache License, Version 2.0 (the
|
|
.. "License"); you may not use this file except in compliance
|
|
.. with the License. You may obtain a copy of the License at
|
|
|
|
.. http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
.. Unless required by applicable law or agreed to in writing,
|
|
.. software distributed under the License is distributed on an
|
|
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
.. KIND, either express or implied. See the License for the
|
|
.. specific language governing permissions and limitations
|
|
.. under the License.
|
|
|
|
.. default-domain:: cpp
|
|
.. highlight:: cpp
|
|
|
|
Getting Started
|
|
===============
|
|
|
|
The following articles demonstrate installation, use, and a basic understanding of Arrow.
|
|
These articles will get you setup quickly using Arrow and give you a taste of what the
|
|
library is capable of.
|
|
Specifically, it contains: an installation and linking guide; documentation of conventions used
|
|
in the codebase and suggested for users; and tutorials, including:
|
|
|
|
* Building Arrow arrays and tabular structures
|
|
* Reading and writing Parquet, Arrow, and CSV files
|
|
* Executing compute kernels on arrays
|
|
* Reading and writing multi-file partitioned datasets
|
|
|
|
Start here to gain a basic understanding of Arrow, and move on to the :doc:`/cpp/user_guide` to
|
|
explore more specific topics and underlying concepts, or the :doc:`/cpp/api` to explore Arrow's
|
|
API.
|
|
|
|
.. toctree::
|
|
|
|
build_system
|
|
conventions
|
|
tutorials/basic_arrow.rst
|
|
tutorials/io_tutorial.rst
|
|
tutorials/compute_tutorial.rst
|
|
tutorials/datasets_tutorial.rst
|