fix: PDF files not deployed to GitHub Pages #226
Merged
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
FORD was wiping the build/doc directory clean before generating documentation, removing any media files copied beforehand. This caused PDF files to be missing from GitHub Pages deployment, resulting in 404 errors. Fixed by reordering the make doc target to: 1. Run FORD first to generate documentation structure 2. Copy media files after FORD completes This ensures media files are preserved in the final build/doc directory that gets deployed to GitHub Pages. fixes #224
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Technical Details
The
make doctarget was copying media files tobuild/doc/media/examplesbefore running FORD, but FORD clears the entirebuild/docdirectory when generating documentation. This meant PDF files were copied and then immediately removed.Before:
After:
Testing
Verified locally that:
make example ARGS="scale_examples"generates PDFs in output/make docpreserves PDFs in build/doc/media/examples/The example PDF mentioned in issue #224:
https://lazy-fortran.github.io/fortplot/media/examples/scale_examples/log_scale.pdfShould now be accessible once deployed.
Impact
Fixes all PDF download links in the documentation that were returning 404 errors.
Closes #224