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

Links are case sensitive #637

Closed MicEsp22 closed 4 months ago

MicEsp22 commented 4 months ago

I'm sorry to be opening this issue. It is more of a discussion than an issue, since for sure it is a detail I am missing to make what I want working.

I cannot make links to work, when cross-referencing module procedures interafaces.

Here is an example:

module test
   implicit none
   interface
       module subroutine sub1()
           !! This one references [[sub2]]
       end subroutine

       module subroutine sub2()
           !! This one rerferences [[sub1]]
       end subroutine
   end interface
end module

I tried all sorts of combinations of [[component(type):item(type)]]. None of them seemed to work.

I'd love guidance in understanding how to make this to work. Many thanks

MicEsp22 commented 4 months ago

Finally managed. It was a mere issue of case sensitivity... (I was preserving the case in the name of the symbol, while apparently all lowercase was needed).

PS: might be good to maybe specify it in the documentation, if not already there (I could not find it).

ZedThree commented 4 months ago

Oh dear, sorry for the bother @MicEsp22, I would also assume that it was case-insensitive. I'll see if I can get a fix this week