Fortran-FOSS-Programmers / ford

Automatically generates FORtran Documentation from comments within the code.
https://forddocs.readthedocs.io
GNU General Public License v3.0
405 stars 131 forks source link

Add more projects to corpus tests #590

Open ZedThree opened 10 months ago

ZedThree commented 10 months ago
mathomp4 commented 10 months ago

@ZedThree Note that, oddly, MAPL with graphs and search is oddly "fast" when running under GitHub Actions. Takes like 10 minutes or so.

Now on a MacBook, the graph generation can take ages so, yes, if you are testing locally, just don't do the graphs!

Also, thank you for reminding me that I need to update the esmf Ford docs I tried out a loong time ago. You can see the attempt at a Ford control file I made here:

https://raw.githubusercontent.com/mathomp4/esmf/doctest/Ford/docs.md

though this was with Ford 6. Possible it might go kaboom with Ford 7. I'll try that out now...once I remember how I trigger the docs...

ZedThree commented 10 months ago

Ah, yes there's probably still an open issue about that. I suspect it's not Ford but graphviz.

Unless you've got some custom CSS, I think everything should work fine in 7 for ESMF.

mathomp4 commented 10 months ago

@ZedThree You were right. It worked!

https://mathomp4.github.io/esmf/index.html

Note these are not official ESMF docs. I mainly generated them so that the MAPL docs could "link" to them (I was experimenting with Ford). Someday I might try and convince @theurich and the other ESMF folks to look at Ford. :)

ESMF
The Earth System Modeling Framework (ESMF) is a suite of software tools for developing high-performance, multi-component Earth science modeling applications.
ZedThree commented 10 months ago

Excellent, pleased to hear it!

I hadn't realised they were official -- probably doesn't make sense to include them in the corpus tests just yet then