Skip to content

Commit e5e2147

Browse files
authored
fix: remove YAML metadata from doc.md to fix GitHub Pages display (#405)
## Summary - Fixes the issue where FORD configuration metadata was appearing as raw text on GitHub Pages - Configuration moved to fpm.toml where it belongs - Documentation now displays cleanly without metadata artifacts ## Problem The GitHub Pages documentation at https://lazy-fortran.github.io/fortplot/ was showing raw YAML configuration text instead of a clean summary. This was due to incorrect FORD metadata format in doc.md. ## Solution - Removed all YAML metadata from doc.md (keeping only markdown content) - Simplified the [extra.ford] configuration in fpm.toml to essential settings - FORD now correctly reads configuration from fpm.toml and displays clean documentation ## Testing - Regenerated documentation locally with `ford doc.md` - Verified that build/doc/index.html no longer contains metadata text - Confirmed clean HTML output without configuration artifacts Fixes #399
1 parent fc9dbc1 commit e5e2147

File tree

3 files changed

+3
-28
lines changed

3 files changed

+3
-28
lines changed

BACKLOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
*All user-facing issues moved to DOING*
1212

1313
**Infrastructure & Documentation Issues (Lower Priority)**
14-
- [ ] #399: Fix - Strange summary on github pages - unwanted FORD configuration appearing in documentation
1514
- [ ] #403: Refactor - reduce contour function complexity - functions exceed 50-line target
1615

1716
## DOING (Current Work)
17+
- [ ] #399: Fix - Strange summary on github pages - unwanted FORD configuration appearing in documentation
1818

1919
## FUTURE SPRINTS - Systematic Restoration
2020

doc.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,3 @@
1-
summary: Modern Fortran plotting library with multiple backends
2-
author: Plasma Theory Group, TU Graz
3-
author_description: Computational plasma physics research group
4-
github: https://github.com/krystophny/fortplotlib
5-
project_github: https://github.com/krystophny/fortplotlib
6-
project_download: https://github.com/krystophny/fortplotlib/releases
7-
output_dir: ./build/doc
8-
media_dir: ./doc/media
9-
page_dir: ./doc
10-
src_dir: ./src
11-
./example
12-
exclude_dir: ./thirdparty
13-
./build
14-
./test
15-
./app
16-
preprocessor: cpp -E
17-
macro: USE_FORD
18-
display: public
19-
protected
20-
private
21-
source: true
22-
graph: true
23-
search: true
24-
extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html
25-
iso_c_binding:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fC_005fBINDING.html
26-
271
Welcome to the fortplotlib documentation. This library provides a modern, matplotlib-inspired plotting interface for Fortran with multiple backends including PNG, PDF, and ASCII.
282

293
## Features

fpm.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ source-form = "free"
2626

2727
[extra.ford]
2828
project = "fortplot"
29-
src_dir = "src"
29+
summary = "Modern Fortran plotting library with multiple backends"
30+
src_dir = ["src", "example"]
3031
output_dir = "build/doc"
3132
page_dir = "doc"
3233
exclude = "fortplot_pdf_text.f90"

0 commit comments

Comments
 (0)