From 29b52397c76b167faa5474102a9b8c56fbd80741 Mon Sep 17 00:00:00 2001 From: Christopher Albert Date: Sat, 23 Aug 2025 10:15:00 +0200 Subject: [PATCH] revert: restore original working documentation configuration Revert README.md and docs workflow to last known working state from commit e411d6f. The FORD configuration was incorrectly added to README.md when it already existed in fpm.toml [extra.ford] section. Original working setup: - FORD config in fpm.toml only - Simple docs workflow without ImageMagick complexity - No FORD metadata in README.md This should restore examples functionality on GitHub Pages. Co-Authored-By: Claude --- .github/workflows/docs.yml | 36 ++---------------------------------- README.md | 17 ----------------- 2 files changed, 2 insertions(+), 51 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 72194e98..01160ee3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -38,9 +38,9 @@ jobs: run: | pip install ford - # Install ffmpeg for animation generation and imagemagick for placeholder images + # Install ffmpeg for animation generation sudo apt-get update - sudo apt-get install -y ffmpeg imagemagick + sudo apt-get install -y ffmpeg # Install fpm (Fortran Package Manager) - same version as CI 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: cp -r "${dir}"*.mp4 "doc/media/examples/${example_name}/" 2>/dev/null || true done - # Create placeholder files for missing example outputs - # This ensures documentation links don't break when examples fail to generate outputs - - # Extract expected image files from documentation - expected_files=$(grep -roh '../../media/examples/[^)]*\.\(png\|pdf\)' doc/example/ | sed 's|../../media/examples/||' | sort -u) - - for file_path in $expected_files; do - full_path="doc/media/examples/$file_path" - if [ ! -f "$full_path" ]; then - echo "Creating placeholder for missing file: $file_path" - mkdir -p "$(dirname "$full_path")" - - # Create different placeholders based on file extension - if [[ "$file_path" == *.png ]]; then - # Create a placeholder PNG using ImageMagick or a simple text file if not available - if command -v convert >/dev/null 2>&1; then - convert -size 640x480 xc:lightgray -pointsize 24 -draw "gravity center fill black text 0,0 'Example output not available'" "$full_path" - else - # Fallback: create a text file that can serve as placeholder - echo "Example output not available - check repository for source code" > "$full_path" - fi - elif [[ "$file_path" == *.pdf ]]; then - # Create a placeholder PDF or text file - if command -v convert >/dev/null 2>&1; then - convert -size 640x480 xc:white -pointsize 20 -draw "gravity center fill black text 0,0 'PDF Example not available'" "$full_path" - else - echo "PDF Example output not available - check repository for source code" > "$full_path" - fi - fi - fi - done - # Generate example documentation from README files make example ARGS="generate_example_docs" diff --git a/README.md b/README.md index 6f7fd6d2..79893470 100644 --- a/README.md +++ b/README.md @@ -418,20 +418,3 @@ time make example_matplotlib time make example_python 1.35s user 0.17s system 97% cpu 1.562 total ``` - ---- -project: fortplot -summary: Fortran-native plotting library inspired by matplotlib -author: lazy-fortran contributors -page_dir: ./doc -media_dir: ./media -src_dir: ./src -exclude_dir: ./build -exclude: fortplot_c_bindings.f90 - fortplot_python.f90 -extensions: f90 -source: true -graph: false -search: true -favicon: ./media/logo.jpg ----