search

Fortran-FOSS-Programmers / ford

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

Can't link from a page to source code #626

Closed fedebenelli closed 5 months ago

fedebenelli commented 5 months ago

I'm trying to link from a page to the documentation of a module of my code but I doesn't seem work right. I've followed the https://github.com/Fortran-FOSS-Programmers/ford/wiki/Writing-Documentation#links instructions but the generated links points to a substructure in the page folder.

As an example, if I want to link to module my_mod from a page I write "you can see more info about my_mod at [[my_mod(module)]]". And the link points to ford_site_dir/page_dir/module/my_mod.html instead of ford_site_dir/module/my_mod.html. I don't know if this is a bug or I'm doing something wrong.

Thank you for your work! I'm very grateful of having nice documentation on Fortran :)

ZedThree commented 5 months ago

@fedebenelli That certainly sounds like a bug. Please could you tell me what version of Ford you're using? The latest version is 7.0.5, for reference.

Please could you also provide a minimal example? That will help me track the bug down much faster

fedebenelli commented 5 months ago

Thank you for the response! My Ford version was 7.0.1 and upgrading to 7.0.5 seems to have fixed it. Anyways before trying that I've added an example repo that does replicate the bug with 7.0.1: https://github.com/fedebenelli/ford_bug_example

GitHub
GitHub - fedebenelli/ford_bug_example
Contribute to fedebenelli/ford_bug_example development by creating an account on GitHub.
ZedThree commented 5 months ago

Great, glad it's fixed!