Documenter.jl:忽略docstring

Question

使用Documenter.jl，我一直收到以下警告：

┌ Warning: 60 docstrings not included in the manual:
│ 
│     ProtoSyn.Calculators.TorchANI.r_xml_travel! :: Union{Tuple{T}, Tuple{Union{LightXML.XMLDocument, LightXML.XMLElement}, String, Vector{T}}} where T<:AbstractFloat
│     ProtoSyn.Clustering.dunn_index :: Union{Tuple{T}, Tuple{Vector{T}, Matrix{T}}} where T<:AbstractFloat
│     ProtoSyn.Calculators.get_available_energy_function_components :: Tuple{Module}
│     Base.resize! :: Tuple{ProtoSyn.Calculators.VerletList, Int64}
│     ProtoSyn.Common
(...)

我想忽略一些(大部分)这些文档字符串(它们存在于代码库中，但我不想将它们导出到最终文档网站)。如何忽略单个的文档字符串？

Answer 1

您应该尝试通过在调用checkdocs时指定makedocs()关键字选项来抑制此类警告。只有当未使用的docstring的函数被导出时，才使用checkdocs=:exports。如果在makedocs中使用checkdocs=:none，则会导致makedocs忽略未使用的文档字符串。但是，对于格式错误的docstring，您可能会丢失一些错误警告。