Documenter.jlUndefVarError

Question

我正在尝试使用 Documenter.jl 为 Julia 模块创建文档。现在我导入了一个模块，由于某种原因文档无法找到。更明确地说：我通过 import SparseArrays 导入 SparseArrays.jl 并在文档字符串中引用 SparseArrays.AbstractSparseArray 。（我也安装了 SparseArrays.jl。）但我得到 ERROR: LoadError: UndefVarError: SparseArrays not defined。这是什么原因，我该如何解决？

编辑：代码的相关部分如下所示：

module ExampleModule
import SparseArrays
include("example.jl")
end

example.jl:

"""
    f
does stuff.
"""
function f(x::SparseArrays.AbstractSparseArray)
    return
end

index.md:

```@docs
f(x::SparseArrays.AbstractSparseArray)
```

Answer 1

很可能您已将其导入到单独的代码块中。有关问题的解释，请参阅 here。

您可能还需要按照 here 的说明在设置代码中添加 import SparseArrays。这是需要的，例如你在文档字符串中有文档测试。

Here 是如何在 DataFrames.jl 中完成的示例（通常 DataFrames.jl 在文档字符串和文档代码中都启用了 doctests，因此您可以查看整个我们有设置）。

如果这不是原因，那么您能否在问题中分享您的代码以便对其进行检查？

Documenter.jlUndefVarError

Documenter.jl UndefVarError

import

undefined

documentation-generation

julia

undefvarerror