Skip to content

Commit fad78d5

Browse files
krystophnyclaude
andauthored
revert: restore original working documentation configuration (#204)
## Summary Revert README.md and docs workflow to last known working state that was showing examples properly on GitHub Pages. ## Root Cause Analysis I incorrectly added FORD configuration to README.md when it already existed in fpm.toml [extra.ford] section, causing deployment hangs and breaking the examples display. ## Changes Reverted - **README.md**: Removed FORD metadata block that conflicted with fmp.toml config - **.github/workflows/docs.yml**: Removed ImageMagick placeholder system that was causing hangs - Restored simple workflow that uses `make doc` which calls `ford README.md` with config from fpm.toml ## Expected Result Examples should appear properly on GitHub Pages as they did before, using the original working FORD configuration from fpm.toml. This fixes the deployment infrastructure by returning to the last known working state. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Claude <noreply@anthropic.com>
1 parent 3e7cf26 commit fad78d5

File tree

2 files changed

+2
-51
lines changed

2 files changed

+2
-51
lines changed

.github/workflows/docs.yml

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ jobs:
3838
run: |
3939
pip install ford
4040
41-
# Install ffmpeg for animation generation and imagemagick for placeholder images
41+
# Install ffmpeg for animation generation
4242
sudo apt-get update
43-
sudo apt-get install -y ffmpeg imagemagick
43+
sudo apt-get install -y ffmpeg
4444
4545
# Install fpm (Fortran Package Manager) - same version as CI
4646
wget https://github.com/fortran-lang/fpm/releases/download/v0.12.0/fpm-0.12.0-linux-x86_64-gcc-12
@@ -73,38 +73,6 @@ jobs:
7373
cp -r "${dir}"*.mp4 "doc/media/examples/${example_name}/" 2>/dev/null || true
7474
done
7575
76-
# Create placeholder files for missing example outputs
77-
# This ensures documentation links don't break when examples fail to generate outputs
78-
79-
# Extract expected image files from documentation
80-
expected_files=$(grep -roh '../../media/examples/[^)]*\.\(png\|pdf\)' doc/example/ | sed 's|../../media/examples/||' | sort -u)
81-
82-
for file_path in $expected_files; do
83-
full_path="doc/media/examples/$file_path"
84-
if [ ! -f "$full_path" ]; then
85-
echo "Creating placeholder for missing file: $file_path"
86-
mkdir -p "$(dirname "$full_path")"
87-
88-
# Create different placeholders based on file extension
89-
if [[ "$file_path" == *.png ]]; then
90-
# Create a placeholder PNG using ImageMagick or a simple text file if not available
91-
if command -v convert >/dev/null 2>&1; then
92-
convert -size 640x480 xc:lightgray -pointsize 24 -draw "gravity center fill black text 0,0 'Example output not available'" "$full_path"
93-
else
94-
# Fallback: create a text file that can serve as placeholder
95-
echo "Example output not available - check repository for source code" > "$full_path"
96-
fi
97-
elif [[ "$file_path" == *.pdf ]]; then
98-
# Create a placeholder PDF or text file
99-
if command -v convert >/dev/null 2>&1; then
100-
convert -size 640x480 xc:white -pointsize 20 -draw "gravity center fill black text 0,0 'PDF Example not available'" "$full_path"
101-
else
102-
echo "PDF Example output not available - check repository for source code" > "$full_path"
103-
fi
104-
fi
105-
fi
106-
done
107-
10876
# Generate example documentation from README files
10977
make example ARGS="generate_example_docs"
11078

README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -418,20 +418,3 @@ time make example_matplotlib
418418
time make example_python
419419
1.35s user 0.17s system 97% cpu 1.562 total
420420
```
421-
422-
---
423-
project: fortplot
424-
summary: Fortran-native plotting library inspired by matplotlib
425-
author: lazy-fortran contributors
426-
page_dir: ./doc
427-
media_dir: ./media
428-
src_dir: ./src
429-
exclude_dir: ./build
430-
exclude: fortplot_c_bindings.f90
431-
fortplot_python.f90
432-
extensions: f90
433-
source: true
434-
graph: false
435-
search: true
436-
favicon: ./media/logo.jpg
437-
---

0 commit comments

Comments
 (0)