Skip to content

Commit ef5ab5f

Browse files
sbryngelsonclaude
andcommitted
Link scaling plot to performance page, harden lychee CI config
- Make weak scaling card clickable (links to expectedPerformance.html) - Fix lychee exclude_path: glob to regex syntax for CLI compatibility - Add URL exclude for sitemap referenced in robots.txt - Move publish step before lychee so deploys are not blocked by link errors - Set lychee fail: true so broken links fail CI - Add VERBATIM to inject-dates CMake custom command Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent abcc794 commit ef5ab5f

4 files changed

Lines changed: 14 additions & 10 deletions

File tree

.github/workflows/docs.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,6 @@ jobs:
6161
echo "url-count = ${{ steps.sitemap.outputs.url-count }}"
6262
echo "excluded-count = ${{ steps.sitemap.outputs.excluded-count }}"
6363
64-
- name: Linkcheck - Lychee
65-
uses: lycheeverse/lychee-action@v2
66-
with:
67-
args: -c .lychee.toml build/install/docs/mfc/
68-
fail: false
69-
7064
- name: Publish Documentation
7165
if: github.repository == 'MFlowCode/MFC' && github.ref == 'refs/heads/master' && (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' )
7266
run: |
@@ -83,5 +77,11 @@ jobs:
8377
git -C ../www commit -m "Docs @ ${GITHUB_SHA::7}" || true
8478
git -C ../www push
8579
80+
- name: Linkcheck - Lychee
81+
uses: lycheeverse/lychee-action@v2
82+
with:
83+
args: -c .lychee.toml build/install/docs/mfc/
84+
fail: true
85+
8686
# DOC_PUSH_URL should be of the format:
8787
# --> https://<username>:<token>@github.com/<username>/<repository>

.lychee.toml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,8 @@ accept = ["200", "429"]
1616

1717
verbose = "error"
1818

19-
# Exclude sitemap from link checking (it contains pre-publish production URLs)
20-
exclude_path = ["**/sitemap.xml"]
19+
# Exclude sitemap file from scanning (it contains pre-publish production URLs)
20+
exclude_path = ["sitemap\\.xml"]
21+
22+
# Exclude sitemap URL referenced in robots.txt (only exists after deployment)
23+
exclude = ["https://mflowcode\\.github\\.io/sitemap\\.xml"]

CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -820,6 +820,7 @@ if (MFC_DOCUMENTATION)
820820
"${CMAKE_CURRENT_SOURCE_DIR}"
821821
COMMAND "${CMAKE_COMMAND}" -E touch "${CMAKE_CURRENT_BINARY_DIR}/inject-dates.stamp"
822822
COMMENT "Injecting page dates into documentation"
823+
VERBATIM
823824
)
824825
add_custom_target(inject_page_dates DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/inject-dates.stamp")
825826
add_dependencies(documentation_doxygen inject_page_dates)

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,12 @@
112112
`).join("");
113113

114114
document.getElementById("ft-scaling").innerHTML = scalings.map(s => `
115-
<div class="flex md:w-2/6 mx-auto flex-col text-white rounded bg-slate-900 rounded-b-lg">
115+
<a href="documentation/expectedPerformance.html" class="flex md:w-2/6 mx-auto flex-col text-white rounded bg-slate-900 rounded-b-lg hover:ring-2 hover:ring-amber-400 transition-shadow no-underline">
116116
<div class="flex-1 grid bg-white pb-2">
117117
<img class="place-self-center" src="${s.image}" alt="${s.label}">
118118
</div>
119119
<div class="flex-1 p-2 font-semibold text-center">${s.label}</div>
120-
</div>
120+
</a>
121121
`).join("");
122122

123123
fetch("https://api.github.com/repos/MFlowCode/MFC/releases/latest")

0 commit comments

Comments
 (0)