Skip to content

revert: restore original working documentation configuration #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2025
Merged

revert: restore original working documentation configuration #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 2 additions & 34 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"

Expand Down
17 changes: 0 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Loading