search

JuliaDocs / Documenter.jl

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

The prefixes for some methods are too long #1064

Closed singularitti closed 1 year ago

singularitti commented 5 years ago

For example I have a package. I nest a module deeply, so the exported functions in that module will have long prefix specifying the module structure, e.g., in this page, numerov_iter shows as CleanShot 2019-07-11 at 00 30 17@2x. Is that the way the prefix supposed to be? Is there a way for not showing NumericalMethodsInQuantumMechanics? It is apparent that this function is bonded to this package.

mortenpi commented 5 years ago

I don't think anything exists to drop the prefix at the moment. In general, I would say that you want the prefix to be there since you want to make it clear what function it is exactly.

But we could consider having an at-meta option that allows you to, say, set the module to which the identifiers should be relative to. I'd be happy to review a PR implementing something like that.

odow commented 1 year ago

Duplicate of https://github.com/JuliaDocs/Documenter.jl/issues/253