Documenter.jl：忽略DocString
使用 docormenter.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
(...)
我想忽略一些（我想忽略一些（大多数）这些docstring（它们存在于代码库中，但我不想将它们导出到最终文档网站）。我如何忽略单个docstrings？
Using Documenter.jl, I keep getting these warnings:
┌ 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
(...)
I want to ignore some (most) of these docstrings (they exist in the code base but I do not want to export them to the final documentation website). How can I ignore individual docstrings?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
您应该尝试通过指定
checkDocs关键字选项来抑制此类警告。使用CheckDocs =：Exports仅当导出未使用的DocString功能时才抱怨。如果您在makedoc中使用checkDocs =：无，应导致makedocs忽略未使用的Docstrings。不过，您可能会对畸形的Docstrings失去一些错误警告。You should try suppressing such warnings by specifying the
checkdocskeyword option when callingmakedocs(). Usingcheckdocs=:exportscomplains only if the unused docstring's function is exported. If you usecheckdocs=:nonein makedocs that should causemakedocsto ignore the unused docstrings. You might lose some error warnings for malformed docstrings though.