You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by gi...@apache.org on 2026/04/27 15:45:33 UTC
(datafusion) branch asf-site updated: Publish built docs triggered by 26762977499c3ea581a8c3f698c855c4d607a2c6
This is an automated email from the ASF dual-hosted git repository.
github-actions[bot] pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 53f2c736ac Publish built docs triggered by 26762977499c3ea581a8c3f698c855c4d607a2c6
53f2c736ac is described below
commit 53f2c736ac487f891a825f1817ca6041822f3f78
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Mon Apr 27 15:45:29 2026 +0000
Publish built docs triggered by 26762977499c3ea581a8c3f698c855c4d607a2c6
---
.asf.yaml | 1 +
_sources/contributor-guide/roadmap.md.txt | 2 +-
_sources/contributor-guide/testing.md.txt | 28 ++++++++++++++++++++++
.../library-user-guide/upgrading/49.0.0.md.txt | 2 +-
_sources/user-guide/cli/overview.md.txt | 4 ++--
_sources/user-guide/dataframe.md.txt | 2 +-
_sources/user-guide/sql/format_options.md.txt | 2 +-
contributor-guide/roadmap.html | 2 +-
contributor-guide/testing.html | 24 +++++++++++++++++++
library-user-guide/upgrading/49.0.0.html | 2 +-
searchindex.js | 2 +-
user-guide/cli/overview.html | 4 ++--
user-guide/dataframe.html | 2 +-
user-guide/sql/format_options.html | 2 +-
14 files changed, 66 insertions(+), 13 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 73adb1c058..d953f9c585 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -55,6 +55,7 @@ github:
contexts:
- "Check License Header"
- "Use prettier to check formatting of documents"
+ - "Check Markdown Links"
- "Validate required_status_checks in .asf.yaml"
- "Spell Check with Typos"
# needs to be updated as part of the release process
diff --git a/_sources/contributor-guide/roadmap.md.txt b/_sources/contributor-guide/roadmap.md.txt
index aac0710dad..bfaf398d3f 100644
--- a/_sources/contributor-guide/roadmap.md.txt
+++ b/_sources/contributor-guide/roadmap.md.txt
@@ -19,7 +19,7 @@ under the License.
# Roadmap and Improvement Proposals
-The [project introduction](../user-guide/introduction) explains the
+The [project introduction](../user-guide/introduction.md) explains the
overview and goals of DataFusion, and our development efforts largely
align to that vision.
diff --git a/_sources/contributor-guide/testing.md.txt b/_sources/contributor-guide/testing.md.txt
index 6b8e4568ec..3b644f610b 100644
--- a/_sources/contributor-guide/testing.md.txt
+++ b/_sources/contributor-guide/testing.md.txt
@@ -186,6 +186,34 @@ tested in the same way using the [doc_comment] crate. See the end of
[doc_comment]: https://docs.rs/doc-comment/latest/doc_comment
[core/src/lib.rs]: https://github.com/apache/datafusion/blob/main/datafusion/core/src/lib.rs#L583
+## Documentation Link Checks
+
+Run the internal markdown link check locally:
+
+```shell
+source ci/scripts/utils/tool_versions.sh
+cargo install lychee --locked --version "${LYCHEE_VERSION}"
+bash ci/scripts/markdown_link_check.sh
+```
+
+Notes:
+
+- The script is run with `bash` and is compatible with the default Bash on macOS (no `mapfile` dependency).
+- The CI configuration currently checks internal markdown links only. External `http(s)` and `mailto` links are excluded to avoid flaky failures.
+
+When a link is broken, lychee prints the file and URL/path that failed. For example:
+
+```text
+[docs/source/user-guide/cli/overview.md]:
+ [ERROR] file:///.../docs/source/user-guide/cli/missing-page.md | Cannot find file: File not found. Check if file exists and path is correct
+```
+
+Rust doc comments are validated by rustdoc in CI and can be checked locally with:
+
+```shell
+bash ci/scripts/rust_docs.sh
+```
+
## Benchmarks
### Criterion Benchmarks
diff --git a/_sources/library-user-guide/upgrading/49.0.0.md.txt b/_sources/library-user-guide/upgrading/49.0.0.md.txt
index 92dee81355..92267a80fa 100644
--- a/_sources/library-user-guide/upgrading/49.0.0.md.txt
+++ b/_sources/library-user-guide/upgrading/49.0.0.md.txt
@@ -123,7 +123,7 @@ Or via SQL:
SET datafusion.execution.spill_compression = 'zstd';
```
-For more details about this configuration option, including performance trade-offs between different compression codecs, see the [Configuration Settings](../../user-guide/configs) documentation.
+For more details about this configuration option, including performance trade-offs between different compression codecs, see the [Configuration Settings](../../user-guide/configs.md) documentation.
### Deprecated `map_varchar_to_utf8view` configuration option
diff --git a/_sources/user-guide/cli/overview.md.txt b/_sources/user-guide/cli/overview.md.txt
index 86beea0e82..e0228d3ea0 100644
--- a/_sources/user-guide/cli/overview.md.txt
+++ b/_sources/user-guide/cli/overview.md.txt
@@ -41,5 +41,5 @@ DataFusion CLI v37.0.0
Elapsed 1.969 seconds.
```
-For more information, see the [Installation](installation), [Usage Guide](usage)
-and [Data Sources](datasources) sections.
+For more information, see the [Installation](installation.md), [Usage Guide](usage.md)
+and [Data Sources](datasources.md) sections.
diff --git a/_sources/user-guide/dataframe.md.txt b/_sources/user-guide/dataframe.md.txt
index 85724a7239..d35b543bfd 100644
--- a/_sources/user-guide/dataframe.md.txt
+++ b/_sources/user-guide/dataframe.md.txt
@@ -122,4 +122,4 @@ async fn main() -> Result<()> {
[`collect`]: https://docs.rs/datafusion/latest/datafusion/dataframe/struct.DataFrame.html#method.collect
[library users guide]: ../library-user-guide/using-the-dataframe-api.md
[api reference on docs.rs]: https://docs.rs/datafusion/latest/datafusion/dataframe/struct.DataFrame.html
-[expressions reference]: expressions
+[expressions reference]: expressions.md
diff --git a/_sources/user-guide/sql/format_options.md.txt b/_sources/user-guide/sql/format_options.md.txt
index 3385080314..46d251c18e 100644
--- a/_sources/user-guide/sql/format_options.md.txt
+++ b/_sources/user-guide/sql/format_options.md.txt
@@ -29,7 +29,7 @@ Format-related options can be specified in three ways, in decreasing order of pr
- `COPY` option tuples
- Session-level config defaults
-For a list of supported session-level config defaults, see [Configuration Settings](../configs). These defaults apply to all operations but have the lowest level of precedence.
+For a list of supported session-level config defaults, see [Configuration Settings](../configs.md). These defaults apply to all operations but have the lowest level of precedence.
If creating an external table, table-specific format options can be specified when the table is created using the `OPTIONS` clause:
diff --git a/contributor-guide/roadmap.html b/contributor-guide/roadmap.html
index b3bf71e765..dc67f60293 100644
--- a/contributor-guide/roadmap.html
+++ b/contributor-guide/roadmap.html
@@ -427,7 +427,7 @@ under the License.
-->
<section id="roadmap-and-improvement-proposals">
<h1>Roadmap and Improvement Proposals<a class="headerlink" href="#roadmap-and-improvement-proposals" title="Link to this heading">#</a></h1>
-<p>The <a class="reference internal" href="../user-guide/introduction.html"><span class="doc std std-doc">project introduction</span></a> explains the
+<p>The <a class="reference internal" href="../user-guide/introduction.html"><span class="std std-doc">project introduction</span></a> explains the
overview and goals of DataFusion, and our development efforts largely
align to that vision.</p>
<section id="planning-epics">
diff --git a/contributor-guide/testing.html b/contributor-guide/testing.html
index 5f6717fb3b..34bf8a3a27 100644
--- a/contributor-guide/testing.html
+++ b/contributor-guide/testing.html
@@ -546,6 +546,29 @@ tested in the same way using the <a class="reference external" href="https://doc
<a class="reference external" href="https://github.com/apache/datafusion/blob/main/datafusion/core/src/lib.rs#L583">core/src/lib.rs</a> for more details.</p>
</section>
</section>
+<section id="documentation-link-checks">
+<h2>Documentation Link Checks<a class="headerlink" href="#documentation-link-checks" title="Link to this heading">#</a></h2>
+<p>Run the internal markdown link check locally:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>ci/scripts/utils/tool_versions.sh
+cargo<span class="w"> </span>install<span class="w"> </span>lychee<span class="w"> </span>--locked<span class="w"> </span>--version<span class="w"> </span><span class="s2">"</span><span class="si">${</span><span class="nv">LYCHEE_VERSION</span><span class="si">}</span><span class="s2">"</span>
+bash<span class="w"> </span>ci/scripts/markdown_link_check.sh
+</pre></div>
+</div>
+<p>Notes:</p>
+<ul class="simple">
+<li><p>The script is run with <code class="docutils literal notranslate"><span class="pre">bash</span></code> and is compatible with the default Bash on macOS (no <code class="docutils literal notranslate"><span class="pre">mapfile</span></code> dependency).</p></li>
+<li><p>The CI configuration currently checks internal markdown links only. External <code class="docutils literal notranslate"><span class="pre">http(s)</span></code> and <code class="docutils literal notranslate"><span class="pre">mailto</span></code> links are excluded to avoid flaky failures.</p></li>
+</ul>
+<p>When a link is broken, lychee prints the file and URL/path that failed. For example:</p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>[docs/source/user-guide/cli/overview.md]:
+ [ERROR] file:///.../docs/source/user-guide/cli/missing-page.md | Cannot find file: File not found. Check if file exists and path is correct
+</pre></div>
+</div>
+<p>Rust doc comments are validated by rustdoc in CI and can be checked locally with:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bash<span class="w"> </span>ci/scripts/rust_docs.sh
+</pre></div>
+</div>
+</section>
<section id="benchmarks">
<h2>Benchmarks<a class="headerlink" href="#benchmarks" title="Link to this heading">#</a></h2>
<section id="criterion-benchmarks">
@@ -651,6 +674,7 @@ tested in the same way using the <a class="reference external" href="https://doc
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#user-guide-documentation">User Guide Documentation</a></li>
</ul>
</li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#documentation-link-checks">Documentation Link Checks</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#benchmarks">Benchmarks</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#criterion-benchmarks">Criterion Benchmarks</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#parquet-sql-benchmarks">Parquet SQL Benchmarks</a></li>
diff --git a/library-user-guide/upgrading/49.0.0.html b/library-user-guide/upgrading/49.0.0.html
index 91c8f02b0a..54c307f9bd 100644
--- a/library-user-guide/upgrading/49.0.0.html
+++ b/library-user-guide/upgrading/49.0.0.html
@@ -502,7 +502,7 @@ is more efficient.</p>
<div class="highlight-sql notranslate"><div class="highlight"><pre><span></span><span class="k">SET</span><span class="w"> </span><span class="n">datafusion</span><span class="p">.</span><span class="n">execution</span><span class="p">.</span><span class="n">spill_compression</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'zstd'</span><span class="p">;</span>
</pre></div>
</div>
-<p>For more details about this configuration option, including performance trade-offs between different compression codecs, see the <a class="reference internal" href="../../user-guide/configs.html"><span class="doc std std-doc">Configuration Settings</span></a> documentation.</p>
+<p>For more details about this configuration option, including performance trade-offs between different compression codecs, see the <a class="reference internal" href="../../user-guide/configs.html"><span class="std std-doc">Configuration Settings</span></a> documentation.</p>
</section>
<section id="deprecated-map-varchar-to-utf8view-configuration-option">
<h3>Deprecated <code class="docutils literal notranslate"><span class="pre">map_varchar_to_utf8view</span></code> configuration option<a class="headerlink" href="#deprecated-map-varchar-to-utf8view-configuration-option" title="Link to this heading">#</a></h3>
diff --git a/searchindex.js b/searchindex.js
index d6a14b98eb..e3f3628d22 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"!=":[[73,"op-neq"]],"!~":[[73,"op-re-not-match"]],"!~*":[[73,"op-re-not-match-i"]],"!~~":[[73,"id19"]],"!~~*":[[73,"id20"]],"#":[[73,"op-bit-xor"]],"%":[[73,"op-modulo"]],"&":[[73,"op-bit-and"]],"(relation, name) tuples in logical fields and logical columns are unique":[[15,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[73,"op-multiply"]],"+":[[73,"op-plus"]],"-":[[73,"op-minus"]],"/":[[73,"op-divide"]],"1. Array Literal Con [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"!=":[[73,"op-neq"]],"!~":[[73,"op-re-not-match"]],"!~*":[[73,"op-re-not-match-i"]],"!~~":[[73,"id19"]],"!~~*":[[73,"id20"]],"#":[[73,"op-bit-xor"]],"%":[[73,"op-modulo"]],"&":[[73,"op-bit-and"]],"(relation, name) tuples in logical fields and logical columns are unique":[[15,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[73,"op-multiply"]],"+":[[73,"op-plus"]],"-":[[73,"op-minus"]],"/":[[73,"op-divide"]],"1. Array Literal Con [...]
\ No newline at end of file
diff --git a/user-guide/cli/overview.html b/user-guide/cli/overview.html
index cdc0d8b104..cfab0d19dc 100644
--- a/user-guide/cli/overview.html
+++ b/user-guide/cli/overview.html
@@ -448,8 +448,8 @@ DataFusion<span class="w"> </span>CLI<span class="w"> </span>v37.0.0
Elapsed<span class="w"> </span><span class="m">1</span>.969<span class="w"> </span>seconds.
</pre></div>
</div>
-<p>For more information, see the <a class="reference internal" href="installation.html"><span class="doc std std-doc">Installation</span></a>, <a class="reference internal" href="usage.html"><span class="doc std std-doc">Usage Guide</span></a>
-and <a class="reference internal" href="datasources.html"><span class="doc std std-doc">Data Sources</span></a> sections.</p>
+<p>For more information, see the <a class="reference internal" href="installation.html"><span class="std std-doc">Installation</span></a>, <a class="reference internal" href="usage.html"><span class="std std-doc">Usage Guide</span></a>
+and <a class="reference internal" href="datasources.html"><span class="std std-doc">Data Sources</span></a> sections.</p>
</section>
diff --git a/user-guide/dataframe.html b/user-guide/dataframe.html
index 44b28f0451..8525c92c3d 100644
--- a/user-guide/dataframe.html
+++ b/user-guide/dataframe.html
@@ -442,7 +442,7 @@ approach allows for the overall plan to be optimized before execution. The plan
is evaluated (executed) when an action method is invoked, such as <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/dataframe/struct.DataFrame.html#method.collect"><code class="docutils literal notranslate"><span class="pre">collect</span></code></a>.
See the <a class="reference internal" href="../library-user-guide/using-the-dataframe-api.html"><span class="std std-doc">Library Users Guide</span></a> for more details.</p>
<p>The DataFrame API is well documented in the <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/dataframe/struct.DataFrame.html">API reference on docs.rs</a>.
-Please refer to the <a class="reference internal" href="expressions.html"><span class="doc std std-doc">Expressions Reference</span></a> for more information on
+Please refer to the <a class="reference internal" href="expressions.html"><span class="std std-doc">Expressions Reference</span></a> for more information on
building logical expressions (<code class="docutils literal notranslate"><span class="pre">Expr</span></code>) to use with the DataFrame API.</p>
</section>
<section id="example">
diff --git a/user-guide/sql/format_options.html b/user-guide/sql/format_options.html
index e2ca4dea12..7d3925dfd6 100644
--- a/user-guide/sql/format_options.html
+++ b/user-guide/sql/format_options.html
@@ -439,7 +439,7 @@
<li><p><code class="docutils literal notranslate"><span class="pre">COPY</span></code> option tuples</p></li>
<li><p>Session-level config defaults</p></li>
</ul>
-<p>For a list of supported session-level config defaults, see <a class="reference internal" href="../configs.html"><span class="doc std std-doc">Configuration Settings</span></a>. These defaults apply to all operations but have the lowest level of precedence.</p>
+<p>For a list of supported session-level config defaults, see <a class="reference internal" href="../configs.html"><span class="std std-doc">Configuration Settings</span></a>. These defaults apply to all operations but have the lowest level of precedence.</p>
<p>If creating an external table, table-specific format options can be specified when the table is created using the <code class="docutils literal notranslate"><span class="pre">OPTIONS</span></code> clause:</p>
<div class="highlight-sql notranslate"><div class="highlight"><pre><span></span><span class="k">CREATE</span><span class="w"> </span><span class="k">EXTERNAL</span><span class="w"> </span><span class="k">TABLE</span>
<span class="w"> </span><span class="n">my_table</span><span class="p">(</span><span class="n">a</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="nb">bigint</span><span class="p">)</span>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org