我在另一个包中定义了一个函数,我将其包含在内,然后从我的 Julia 包中导出。我现在想使用 Documenter.jl 在我的文档中包含该功能的文档。我需要什么样的 @ref
语法才能做到这一点? documenter docs似乎并不觊觎这个用例。
最佳答案
这就是我们在 MeasureTheory
中所做的,请随时查看 https://github.com/cscherrer/MeasureTheory.jl/blob/master/docs/make.jl .我们的目标是也包括来自 MeasureBase
的文档字符串,所有这一切都需要对 make.jl
文件进行一些调整:
- 在
makedocs
的modules
参数中包含这两个包 - 为两个包设置doctests
请注意 MeasureTheory
重新导出 MeasureBase
,否则我们也需要在文件开头添加 using MeasureBase
。
关于julia - 如何在我的 Julia 文档中包含来自另一个包的函数的文档字符串?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/70137119/