Skip to content

Commit 2805afd

Browse files
authored
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]>
1 parent ddab347 commit 2805afd

File tree

4 files changed

+10
-3
lines changed

4 files changed

+10
-3
lines changed

.github/workflows/docs.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
name: Docs
1919

2020
on:
21+
pull_request:
22+
paths:
23+
- '.github/workflows/docs.yml'
24+
- 'cpp/apidoc/**'
25+
- 'docs/**'
2126
push:
2227

2328
permissions:

.github/workflows/docs_light.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,15 @@ on:
2121
pull_request:
2222
paths:
2323
- '.dockerignore'
24-
- 'docs/**'
2524
- '.github/workflows/docs_light.yml'
2625
- 'ci/docker/conda.dockerfile'
2726
- 'ci/docker/conda-cpp.dockerfile'
2827
- 'ci/docker/conda-python.dockerfile'
2928
- 'ci/scripts/cpp_build.sh'
3029
- 'ci/scripts/python_build.sh'
3130
- 'compose.yaml'
31+
- 'cpp/apidoc/**'
32+
- 'docs/**'
3233

3334
permissions:
3435
contents: read

cpp/apidoc/Doxyfile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1096,7 +1096,8 @@ EXCLUDE_PATTERNS = *-test.cc \
10961096
*_generated.h \
10971097
*-benchmark.cc \
10981098
*_codegen.py \
1099-
*internal*
1099+
*internal* \
1100+
*.md
11001101

11011102
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
11021103
# (namespaces, classes, functions, etc.) that should be excluded from the

cpp/src/arrow/flight/sql/odbc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ After the build succeeds, the ODBC DLL will be located in
2626

2727
2. Register your ODBC DLL:
2828

29-
Need to replace <path\to\repo> with actual path to repository in the commands.
29+
Need to replace `<path\to\repo>` with actual path to repository in the commands.
3030
1. `cd to repo.`
3131
2. `cd <path\to\repo>`
3232
3. Run script to register your ODBC DLL as Apache Arrow Flight SQL ODBC Driver

0 commit comments

Comments
 (0)