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.
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
Documentation generation on my local machine and on github gives different outcomes #647
Comments
Hi Jules, my initial guess is that this is something to do with checking out the code -- Ford can't find some files that are maybe in an external library or git submodule perhaps? If you try a clean checkout locally, do you see the same issue? |
@ZedThree Here is the odd thing. If you look at the GitHub Actions output you'll see (for example):
However, we have this file excluded, we think: exclude: **/EsmfRegridder.F90
...
**/generic3g/couplers/esmf-way/CouplerMetaComponent.F90 Note that we also tried: ../../generic3g/couplers/esmf-way/CouplerMetaComponent.F90 and it still didn't exclude it. Is there perhaps something we are doing wrong to exclude that file? Maybe if we get the syntax right, we can figure out all the other issues... |
This is actually a bug, the paths in the settings file are supposed to be relative to the setting file, but (at least) the exclude paths get processed relative to where you run For now, a workaround is to just run Some notes for myself: This is here: Lines 124 to 127 in 8e05e45
When fnmatch(os.path.relpath(src), exclude) becomes: fnmatch('generic3g/couplers/esmf-way/GenericCoupler.F90', '**/generic3g/couplers/esmf-way/GenericCoupler.F90') which is |
Ah ha! And I bet both @JulesKouatchou and myself always run ford from the I'll test this soon. -- A query @ZedThree: assuming this all works, what is the "right" way to exclude a specific filename in one subdir but not another? Is it:
or:
(since we know exactly where things are relative to the ford control file) Note we probably have to be specific like this with subdirs, because MAPL3 is slowly becoming based more on path so we might have:
and maybe |
The benefit of the The second one is perhaps a bit more explicit, with the downside of maybe being more fragile if you ever rearrange your project directories. |
@ZedThree Makes sense. We'll stick with the And good news! With your workaround--and some more excludes--we have some docs: https://geos-esm.github.io/MAPL/mapl3-doc/ 🎉 Now it's time to start enforcing style, etc. as bits are leaking into places. 😄
|
Hi Peter,
Thank you again for solving Issue #638. With Ford 7.0.6, I can generate the documentation without any problem on my local Mac. However, when my co-worker attempts to do it in github (same code), there are error messages.
https://github.com/GEOS-ESM/MAPL/actions/runs/8601316694/job/23568290998
Do you know if there is any setting we need to have to make it work?
Thanks.
Jules
In case you cannot access the above page, I pasted below part of the Github output:
The text was updated successfully, but these errors were encountered: