This is an automated email from the ASF dual-hosted git repository.
kou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 2805afd27e GH-48782: [Docs][CI] Skip Markdown files with doxygen and
trigger Docs job on PR when files are modified (#48786)
2805afd27e is described below
commit 2805afd27e291db0277e9be26f345fff474cd0bb
Author: Raúl Cumplido <[email protected]>
AuthorDate: Fri Jan 9 07:43:56 2026 +0100
GH-48782: [Docs][CI] Skip Markdown files with doxygen and trigger Docs job
on PR when files are modified (#48786)
### Rationale for this change
Docs jobs are currently failing with Doxygen failure due to parsing the
`cpp/src/arrow/flight/sql/odbc/README.md` file.
### What changes are included in this PR?
Minor fix to escape path and add Skip markdown files when running doxygen
on doxygen config.
Add trigger for Complete docs workflow on Pull requests when documentation
is modified.
### Are these changes tested?
Yes locally.
### Are there any user-facing changes?
No
* GitHub Issue: #48782
Authored-by: Raúl Cumplido <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
---
.github/workflows/docs.yml | 5 +++++
.github/workflows/docs_light.yml | 3 ++-
cpp/apidoc/Doxyfile | 3 ++-
cpp/src/arrow/flight/sql/odbc/README.md | 2 +-
4 files changed, 10 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 25d88bc7ba..8e17699462 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -18,6 +18,11 @@
name: Docs
on:
+ pull_request:
+ paths:
+ - '.github/workflows/docs.yml'
+ - 'cpp/apidoc/**'
+ - 'docs/**'
push:
permissions:
diff --git a/.github/workflows/docs_light.yml b/.github/workflows/docs_light.yml
index baf1d25dbd..601a989a10 100644
--- a/.github/workflows/docs_light.yml
+++ b/.github/workflows/docs_light.yml
@@ -21,7 +21,6 @@ on:
pull_request:
paths:
- '.dockerignore'
- - 'docs/**'
- '.github/workflows/docs_light.yml'
- 'ci/docker/conda.dockerfile'
- 'ci/docker/conda-cpp.dockerfile'
@@ -29,6 +28,8 @@ on:
- 'ci/scripts/cpp_build.sh'
- 'ci/scripts/python_build.sh'
- 'compose.yaml'
+ - 'cpp/apidoc/**'
+ - 'docs/**'
permissions:
contents: read
diff --git a/cpp/apidoc/Doxyfile b/cpp/apidoc/Doxyfile
index baf848ca23..9cff530791 100644
--- a/cpp/apidoc/Doxyfile
+++ b/cpp/apidoc/Doxyfile
@@ -1096,7 +1096,8 @@ EXCLUDE_PATTERNS = *-test.cc \
*_generated.h \
*-benchmark.cc \
*_codegen.py \
- *internal*
+ *internal* \
+ *.md
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
diff --git a/cpp/src/arrow/flight/sql/odbc/README.md
b/cpp/src/arrow/flight/sql/odbc/README.md
index c40ba3636e..b8a971e4d4 100644
--- a/cpp/src/arrow/flight/sql/odbc/README.md
+++ b/cpp/src/arrow/flight/sql/odbc/README.md
@@ -26,7 +26,7 @@ After the build succeeds, the ODBC DLL will be located in
2. Register your ODBC DLL:
- Need to replace <path\to\repo> with actual path to repository in the
commands.
+ Need to replace `<path\to\repo>` with actual path to repository in the
commands.
1. `cd to repo.`
2. `cd <path\to\repo>`
3. Run script to register your ODBC DLL as Apache Arrow Flight SQL ODBC
Driver