使用 Documenter.jl 添加函数文档字符串

时间:2021-06-03 12:48:48

标签: julia documentation-generation

我正在尝试使用 Documenter.jl 为 Julia 包创建文档。 (虽然我对 Julia 还是很陌生。)现在我想知道如何让所有带有文档字符串的函数出现在文档中?我知道我可以通过

添加一个函数f
## Functions

```@docs
f
```

在 markdown 文件中,但这意味着我必须手动添加所有功能。没有办法自动添加所有功能吗?

1 个答案:

答案 0 :(得分:1)

好的,任何有兴趣的人我都知道怎么做:

```@autodocs
Modules = [Foo, Bar]
Order   = [:function, :type]
```

https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@docs-block所示。