fix: prevent CI workflow from overwriting FORD-generated HTML files #219
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The GitHub Actions workflow was copying markdown files from doc/example/*.md to build/doc/page/example/ AFTER FORD had already generated the HTML files. This overwrote the generated basic_plots.html with basic_plots.md, causing 404 errors for HTML pages. FORD correctly processes doc/example/*.md and generates HTML files. The extra copy step was unnecessary and destructive. Fixes GitHub Pages 404 errors for example HTML documentation.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
krystophny
added a commit
that referenced
this pull request
Aug 23, 2025
…220) ## Problem GitHub Pages was still showing 404 errors for example HTML documentation after PR #219, specifically: - https://lazy-fortran.github.io/fortplot/page/example/basic_plots.html - https://lazy-fortran.github.io/fortplot/page/example/annotation_demo.html ## Root Cause Analysis Investigation of CI logs revealed that FORD was still reporting UTF-8 parsing errors for specific files: ``` Warning: Error parsing '/home/runner/work/fortplot/fortplot/doc/example/basic_plots.md'. utf-8 ``` These UTF-8 parsing errors were preventing FORD from generating HTML files for those documents. ## The Issue A single UTF-8 character (π symbol) in `basic_plots.md` was causing the problem: ```fortran ! Generate simple sine data - show 2 complete periods (0 to 4π) ``` While this works fine in local development environments, the CI environment has stricter UTF-8 handling that caused FORD parsing to fail. ## Solution Replace the π symbol with ASCII 'pi': ```fortran ! Generate simple sine data - show 2 complete periods (0 to 4pi) ``` ## Verification - Local testing: `file -bi doc/example/basic_plots.md` now returns `charset=us-ascii` - All example markdown files are now ASCII-only - FORD should generate HTML files successfully in CI This final fix should resolve the remaining GitHub Pages 404 errors.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
GitHub Pages was showing 404 errors for example HTML documentation pages like:
Root Cause Analysis
The GitHub Actions workflow in
.github/workflows/docs.ymlwas:make docwhich callsford README.mdto generate HTML files fromdoc/example/*.mddoc/example/*.mdfiles tobuild/doc/page/example/basic_plots.htmlwithbasic_plots.mdFORD correctly processes markdown files and generates HTML, but the workflow was destroying the output.
Solution
Remove the problematic copy step that overwrites FORD-generated HTML files:
Verification
Local testing confirms:
make docgeneratesbuild/doc/page/example/basic_plots.htmlThis fix will resolve the GitHub Pages 404 errors.