This is an automated email from the ASF dual-hosted git repository.
agrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-comet.git
The following commit(s) were added to refs/heads/main by this push:
new d5ac803b7 fix docs warnings (#2320)
d5ac803b7 is described below
commit d5ac803b70969b82f68f72f4143659903cb14292
Author: Andy Grove <agr...@apache.org>
AuthorDate: Fri Sep 5 13:12:28 2025 -0600
fix docs warnings (#2320)
---
docs/source/contributor-guide/development.md | 2 +-
docs/source/contributor-guide/plugin_overview.md | 2 +-
docs/source/contributor-guide/spark-sql-tests.md | 6 +++---
docs/source/gluten_comparison.md | 2 +-
docs/source/index.rst | 3 +--
docs/source/overview.md | 2 +-
docs/source/user-guide/0.8/index.rst | 4 ++--
docs/source/user-guide/0.9/index.rst | 4 ++--
docs/source/user-guide/latest/datasources.md | 8 ++++----
docs/source/user-guide/latest/iceberg.md | 2 +-
docs/source/user-guide/latest/index.rst | 8 ++++----
11 files changed, 21 insertions(+), 22 deletions(-)
diff --git a/docs/source/contributor-guide/development.md
b/docs/source/contributor-guide/development.md
index 770d12f71..312cb55ed 100644
--- a/docs/source/contributor-guide/development.md
+++ b/docs/source/contributor-guide/development.md
@@ -30,7 +30,7 @@ under the License.
## Development Setup
-1. Make sure `JAVA_HOME` is set and point to JDK using [support
matrix](/docs/source/user-guide/latest/installation.md)
+1. Make sure `JAVA_HOME` is set and point to JDK using [support
matrix](../user-guide/latest/installation.md)
2. Install Rust toolchain. The easiest way is to use
[rustup](https://rustup.rs).
diff --git a/docs/source/contributor-guide/plugin_overview.md
b/docs/source/contributor-guide/plugin_overview.md
index add4172d5..4f6863b03 100644
--- a/docs/source/contributor-guide/plugin_overview.md
+++ b/docs/source/contributor-guide/plugin_overview.md
@@ -147,4 +147,4 @@ accessing Arrow data structures from multiple languages.
The following diagram shows an example of the end-to-end flow for a query
stage.
-
+
diff --git a/docs/source/contributor-guide/spark-sql-tests.md
b/docs/source/contributor-guide/spark-sql-tests.md
index 1425b163b..5666c8ceb 100644
--- a/docs/source/contributor-guide/spark-sql-tests.md
+++ b/docs/source/contributor-guide/spark-sql-tests.md
@@ -54,7 +54,7 @@ git apply ../datafusion-comet/dev/diffs/3.4.3.diff
## 3. Run Spark SQL Tests
-#### Use the following commands to run the Spark SQL test suite locally.
+### Use the following commands to run the Spark SQL test suite locally.
```shell
ENABLE_COMET=true build/sbt catalyst/test
@@ -65,7 +65,7 @@ ENABLE_COMET=true build/sbt "hive/testOnly * -- -l
org.apache.spark.tags.Extende
ENABLE_COMET=true build/sbt "hive/testOnly * -- -n
org.apache.spark.tags.ExtendedHiveTest"
ENABLE_COMET=true build/sbt "hive/testOnly * -- -n
org.apache.spark.tags.SlowHiveTest"
```
-#### Steps to run individual test suites through SBT
+### Steps to run individual test suites through SBT
1. Open SBT with Comet enabled
```shell
ENABLE_COMET=true sbt -J-Xmx4096m -Dspark.test.includeSlowTests=true
@@ -74,7 +74,7 @@ ENABLE_COMET=true sbt -J-Xmx4096m
-Dspark.test.includeSlowTests=true
```shell
sql/testOnly org.apache.spark.sql.DynamicPartitionPruningV1SuiteAEOn -- -z
"SPARK-35568"
```
-#### Steps to run individual test suites in IntelliJ IDE
+### Steps to run individual test suites in IntelliJ IDE
1. Add below configuration in VM Options for your test case (apache-spark
repository)
```shell
-Dspark.comet.enabled=true -Dspark.comet.debug.enabled=true
-Dspark.plugins=org.apache.spark.CometPlugin -DXmx4096m
-Dspark.executor.heartbeatInterval=20000 -Dspark.network.timeout=10000
--add-exports=java.base/sun.nio.ch=ALL-UNNAMED
--add-opens=java.base/java.nio=ALL-UNNAMED
diff --git a/docs/source/gluten_comparison.md b/docs/source/gluten_comparison.md
index e1d20d369..32015a81b 100644
--- a/docs/source/gluten_comparison.md
+++ b/docs/source/gluten_comparison.md
@@ -64,7 +64,7 @@ Comet relies on the full Spark SQL test suite (consisting of
more than 24,000 te
integration tests to ensure compatibility with Spark. Features that are known
to have compatibility differences with
Spark are disabled by default, but users can opt in. See the [Comet
Compatibility Guide] for more information.
-[Comet Compatibility Guide]: compatibility.md
+[Comet Compatibility Guide]: user-guide/latest/compatibility.md
Gluten also aims to provide compatibility with Spark, and includes a subset of
the Spark SQL tests in its own test
suite. See the [Gluten Compatibility Guide] for more information.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 1083400a7..f8122e061 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -43,7 +43,7 @@ as a native runtime to achieve improvement in terms of query
efficiency and quer
Comet Overview <overview>
Comparison with Gluten <gluten_comparison>
-.. _toc.user-guide-links:
+.. _toc.user-guide-links-versioned:
.. toctree::
:maxdepth: 2
:caption: User Guides:
@@ -52,7 +52,6 @@ as a native runtime to achieve improvement in terms of query
efficiency and quer
Comet 0.10.0-SNAPSHOT <user-guide/latest/index>
Comet 0.9.x <user-guide/0.9/index>
Comet 0.8.x <user-guide/0.8/index>
- Comet 0.7.x <user-guide/0.7/index>
.. _toc.contributor-guide-links:
.. toctree::
diff --git a/docs/source/overview.md b/docs/source/overview.md
index a63e1e916..1b5ed1e97 100644
--- a/docs/source/overview.md
+++ b/docs/source/overview.md
@@ -62,4 +62,4 @@ hardware.
Refer to the [Comet Installation Guide] to get started.
-[Comet Installation Guide]: installation.md
+[Comet Installation Guide]: user-guide/latest/installation.md
diff --git a/docs/source/user-guide/0.8/index.rst
b/docs/source/user-guide/0.8/index.rst
index 8c804184c..b34d5e19d 100644
--- a/docs/source/user-guide/0.8/index.rst
+++ b/docs/source/user-guide/0.8/index.rst
@@ -15,14 +15,14 @@
.. specific language governing permissions and limitations
.. under the License.
-.. image:: _static/images/DataFusionComet-Logo-Light.png
+.. image:: /_static/images/DataFusionComet-Logo-Light.png
:alt: DataFusion Comet Logo
=======================
Comet 0.8.x User Guide
=======================
-.. _toc.user-guide-links:
+.. _toc.user-guide-links-08:
.. toctree::
:maxdepth: 1
:caption: Comet 0.8.x User Guide
diff --git a/docs/source/user-guide/0.9/index.rst
b/docs/source/user-guide/0.9/index.rst
index 66acc4123..7a93b4c5c 100644
--- a/docs/source/user-guide/0.9/index.rst
+++ b/docs/source/user-guide/0.9/index.rst
@@ -15,14 +15,14 @@
.. specific language governing permissions and limitations
.. under the License.
-.. image:: _static/images/DataFusionComet-Logo-Light.png
+.. image:: /_static/images/DataFusionComet-Logo-Light.png
:alt: DataFusion Comet Logo
=======================
Comet 0.9.x User Guide
=======================
-.. _toc.user-guide-links:
+.. _toc.user-guide-links-09:
.. toctree::
:maxdepth: 1
:caption: Comet 0.9.x User Guide
diff --git a/docs/source/user-guide/latest/datasources.md
b/docs/source/user-guide/latest/datasources.md
index 45a1e18b0..0dbc86827 100644
--- a/docs/source/user-guide/latest/datasources.md
+++ b/docs/source/user-guide/latest/datasources.md
@@ -122,24 +122,24 @@ Input [3]: [id#0, first_name#1, personal_info#4]
Verify the native scan type should be `CometNativeScan`.
-More on [HDFS Reader](../../../native/hdfs/README.md)
+More on [HDFS
Reader](https://github.com/apache/datafusion-comet/blob/main/native/hdfs/README.md)
### Local HDFS development
- Configure local machine network. Add hostname to `/etc/hosts`
-```commandline
+```shell
127.0.0.1 localhost namenode datanode1 datanode2 datanode3
::1 localhost namenode datanode1 datanode2 datanode3
```
- Start local HDFS cluster, 3 datanodes, namenode url is `namenode:9000`
-```commandline
+```shell
docker compose -f kube/local/hdfs-docker-compose.yml up
```
- Check the local namenode is up and running on
`http://localhost:9870/dfshealth.html#tab-overview`
- Build a project with HDFS support
-```commandline
+```shell
JAVA_HOME="/opt/homebrew/opt/openjdk@11" make release PROFILES="-Pspark-3.5"
COMET_FEATURES=hdfs RUSTFLAGS="-L
/opt/homebrew/opt/openjdk@11/libexec/openjdk.jdk/Contents/Home/lib/server"
```
diff --git a/docs/source/user-guide/latest/iceberg.md
b/docs/source/user-guide/latest/iceberg.md
index af6efc7f7..aa3caa79b 100644
--- a/docs/source/user-guide/latest/iceberg.md
+++ b/docs/source/user-guide/latest/iceberg.md
@@ -143,7 +143,7 @@ scala> spark.sql(s"SELECT * from t1").explain()
```
## Known issues
- - We temporarily disable Comet when there are delete files in Iceberg scan,
see Iceberg [1.8.1 diff](../../../dev/diffs/iceberg/1.8.1.diff) and this
[PR](https://github.com/apache/iceberg/pull/13793)
+ - We temporarily disable Comet when there are delete files in Iceberg scan,
see Iceberg [1.8.1
diff](https://github.com/apache/datafusion-comet/blob/main/dev/diffs/iceberg/1.8.1.diff)
and this [PR](https://github.com/apache/iceberg/pull/13793)
- Iceberg scan w/ delete files lead to [runtime
exceptions](https://github.com/apache/datafusion-comet/issues/2117) and
[incorrect results](https://github.com/apache/datafusion-comet/issues/2118)
- Enabling `CometShuffleManager` leads to [runtime
exceptions](https://github.com/apache/datafusion-comet/issues/2086)
- Spark Runtime Filtering isn't
[working](https://github.com/apache/datafusion-comet/issues/2116)
diff --git a/docs/source/user-guide/latest/index.rst
b/docs/source/user-guide/latest/index.rst
index a82028632..c1c676ef3 100644
--- a/docs/source/user-guide/latest/index.rst
+++ b/docs/source/user-guide/latest/index.rst
@@ -15,14 +15,14 @@
.. specific language governing permissions and limitations
.. under the License.
-.. image:: _static/images/DataFusionComet-Logo-Light.png
+.. image:: /_static/images/DataFusionComet-Logo-Light.png
:alt: DataFusion Comet Logo
-=======================
+================================
Comet 0.10.0-SNAPSHOT User Guide
-=======================
+================================
-.. _toc.user-guide-links:
+.. _toc.user-guide-links-latest:
.. toctree::
:maxdepth: 1
:caption: Comet 0.10.0-SNAPSHOT User Guide
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@datafusion.apache.org
For additional commands, e-mail: commits-h...@datafusion.apache.org
