`@ref` across files in Documenter.jl

General Usage
1

I have split my module into multiple files. I want to cross reference across files.

index.md:

# A
```@autodocs
Pages = [ "A.jl" ]
Modules = [ MyModule ]
` ``

# B

```@autodocs
Pages = [ "B.jl" ]
Modules = [ MyModule ]
` ``

A.jl:

@doc """ mystruct """
struct mystruct end

B.jl:

@doc """ my second struct which is totally different from [my other struct](@ref mystruct)
struct mystruct2 end

I’ve tried:

  • @ref MyModule.mystruct
  • @ref `mystruct`

But Documenter.jl cannot resolve the symbol. If I do this within the same file. There’s no issue using @ref mystruct. Also just using [`mystruct`](@ref) works across files. Is there a flag that would allow this?

2 Likes
2

https://github.com/JuliaDocs/Documenter.jl/issues/781

1 Like
3

What is strange, is that [my text] (@ref mystruct) within the same file does work.