Documenter.jl 中其他子模块的交叉引用函数

Question

给定一个像

这样的模块层次结构

module A
    module B; function foo end; end
    module C
        """
            bar(x)

        Like [`foo`](@ref), but more `bar`.
        """
        function bar end
    end
end

如何使用 Documenter.jl 从 bar 的文档字符串中交叉引用 foo？我试过 A.B.foo、B.foo 和 ..B.foo 都没有成功。

Answer 1

首先，B.foo 和 C.bar 都需要 (i) 有文档字符串并且 (ii) 在降价文件中，例如在 Documenter @docs block.

```@docs
A.B.foo
A.C.bar
```

以便相互参照。其次，绑定 B.foo 必须在 C 模块内可见。这可以通过例如在 C 模块中添加 import ..B: foo （或在 B 中添加 export foo 和 C 中添加 using ..B 来实现.这是一个工作示例：

module A
    module B
        "foo function"
        function foo end
    end
    module C
        import ..B: foo
        """
            bar(x)

        Like [`foo`](@ref), but more `bar`.
        """
        function bar end
    end
end # module

Documenter.jl 中其他子模块的交叉引用函数

Cross-referencing functions from other submodule in Documenter.jl

documentation

cross-reference

julia