JuliaDocs / Documenter.jl

A documentation generator for Julia.
https://documenter.juliadocs.org
MIT License
810 stars 477 forks source link

Hide internal docs from search by default? #2241

Open KristofferC opened 1 year ago

KristofferC commented 1 year ago

Searching for e.g. strict gives as a first result som internal docstrings which are more or less useless for a user:

image

Maybe these should be hidden by default somehow?

mortenpi commented 1 year ago

We don't know what's internal and what is not though, so I am not sure it's actionable on this level. This should maybe be addressed by not including those docstrings in the manual in the first place? But then I think you run into missing docs errors, so we'd need a way to exclude internal docs from that. I think we have a few issues on those fronts already.