代码之家 › 专栏 › 技术社区 › carstenbauer

资料员。jl:@特定源文件的autodocs

julia

2

carstenbauer · 技术社区 · 8 年前

来自文档管理员。jl的文件 @autodocs :

[...], 一页矢量可能包含在@autodocs中以进行筛选 docstrings基于定义它们的源文件:
```@autodocs
Modules = [Foo]
Pages   = ["a.jl", "b.jl"]
```

然而,它也说

请注意,页面匹配是使用所提供字符串的结尾完成的因此,a.jl将与 以.jl结尾的任何源文件 ,即。 src/a.jl或src/foo/a.jl。

如何限制 @自动文档 是否阻止特定源文件?

我的包的源代码组织为

src/
    foo/a.jl
    foo/b.jl
    ignore/a.jl
    ignore/b.jl
    other.jl

如何制作 @自动文档 仅阻止考虑文件 src/foo/a.jl 和 src/foo/b.jl 但不是 src/ignore/a.jl 和 src/ignore/b.jl ?

不幸地 Pages = ["foo/a.jl", "foo/b.jl"] 不是为我做的。

提前谢谢。

1 回复 | 直到 8 年前

1

carstenbauer 8 年前

事实证明,这是一个Windows问题,因为没有规范化路径分隔符(请参阅链接的github问题)。

在Linux上 Pages = ["foo/a.jl", "foo/b.jl"] 应该有用。

在Windows上 Pages = ["foo\\a.jl", "foo\\b.jl"] 应该有用。

编辑: joinpath.("foo", ["a.jl", "b.jl"]) 应该适用于任何操作系统。