Documenter.jl：忽略文档字符串

Question

使用Documenter.jl，我不断收到这些警告：

\n

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

\n

我想忽略其中一些（大多数）文档字符串（它们存在于代码库中，但我不想将它们导出到最终文档网站）。我怎样才能忽略个别文档字符串？

\n

Answer 1

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