Skip to content

Commit fb1697f

Browse files
committed
Docs CI: track docs/_static so sphinx html_static_path resolves
The single remaining sphinx warning under -W was: WARNING: html_static_path entry '_static' does not exist docs/_static/ existed locally (empty) but git doesn't track empty directories, so on a fresh CI checkout the directory was missing and sphinx warned. Add a .gitkeep placeholder so the directory is materialised in CI checkouts. Also revert the temporary workflow diagnostics (log tee + annotation re-emission) used to surface the warning text — back to the plain sphinx-build + html-docs artifact upload now that the issue is found.
1 parent 4d74925 commit fb1697f

2 files changed

Lines changed: 1 addition & 27 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -72,35 +72,9 @@ jobs:
7272
7373
- name: Build HTML docs (warnings-as-errors)
7474
working-directory: UniROS
75-
run: |
76-
mkdir -p docs/_build
77-
set -o pipefail
78-
sphinx-build -W --keep-going -b html docs docs/_build/html 2>&1 | tee docs/_build/sphinx.log
79-
80-
- name: Surface sphinx warnings as annotations
81-
if: failure()
82-
working-directory: UniROS
83-
run: |
84-
echo "===== sphinx.log ====="
85-
cat docs/_build/sphinx.log || echo "(no log file)"
86-
echo "===== warning lines ====="
87-
grep -nE "(WARNING|ERROR)" docs/_build/sphinx.log || echo "(no warnings matched)"
88-
# Re-emit as GitHub annotations so they surface via the check-run API.
89-
while IFS= read -r line; do
90-
echo "::error::${line}"
91-
done < <(grep -E "(WARNING|ERROR)" docs/_build/sphinx.log || true)
92-
93-
- name: Upload sphinx build log
94-
if: always()
95-
uses: actions/upload-artifact@v4
96-
with:
97-
name: sphinx-log
98-
path: UniROS/docs/_build/sphinx.log
99-
retention-days: 14
100-
if-no-files-found: warn
75+
run: sphinx-build -W --keep-going -b html docs docs/_build/html
10176

10277
- name: Upload built docs as artifact
103-
if: success()
10478
uses: actions/upload-artifact@v4
10579
with:
10680
name: html-docs

docs/_static/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)