Skip to content

Extend Fortran API docs#299

Merged
marvinfriede merged 8 commits intomainfrom
extend-docs
Jul 7, 2025
Merged

Extend Fortran API docs#299
marvinfriede merged 8 commits intomainfrom
extend-docs

Conversation

@marvinfriede
Copy link
Copy Markdown
Member

No description provided.

Copy link
Copy Markdown
Member

@awvwgk awvwgk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to have the code snippets as actual Fortran code in the documentation directory and use .. literalinclude:: ./path/to/source.f90? This avoids repeating the same snippet twice because you can include a subset of a file. Also, we can setup a test which actually runs the code snippet and checks whether it compiles with the latest library version.

@marvinfriede marvinfriede force-pushed the extend-docs branch 2 times, most recently from f278243 to af1cd76 Compare July 6, 2025 21:23
@marvinfriede
Copy link
Copy Markdown
Member Author

Is it possible to have the code snippets as actual Fortran code in the documentation directory and use .. literalinclude:: ./path/to/source.f90? This avoids repeating the same snippet twice because you can include a subset of a file. Also, we can setup a test which actually runs the code snippet and checks whether it compiles with the latest library version.

Done. Examples are placed under assets/examples. I created an additional workflow that only fpm runs the examples. For the minimal example, I created a workflow for a fixed version (3.7.0) and for the current version (not HEAD) to test the changes in a branch.

@marvinfriede marvinfriede requested a review from awvwgk July 7, 2025 07:16
Copy link
Copy Markdown
Member

@awvwgk awvwgk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now.

@marvinfriede marvinfriede merged commit 0cba606 into main Jul 7, 2025
44 checks passed
@marvinfriede marvinfriede deleted the extend-docs branch July 7, 2025 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants