I am working on the documentation for module that mostly just bridges the gap between Julia and a C library. There are two methods that I expose that are fully written in Julia because they do not have a counterpart in in the C library but provide functionality that is needed.
These two methods share a bunch of other methods to do what they need to do. So I put all this code in an “internal” module which just exports the two important public methods. Then the parent module re-exports those methods so that the client can easily access this functionality.
The issue is that the Documenter, when listing those two functions, prefixes them with the internal module even though the caller doesn’t need to know about module at all. I’ve searched the Documenter instructions and so far haven’t stumbled upon any flag I could pass to
@docs to trim the module from the name. Anyone know of a way to handle this? Or is the recommendation to just move the exported function up to the main module?
Basically I have this:
module MyModule module InternalMod export func1 """ func1() """ function func1() = 1 end using .InternalMod export func1 end
@docs in the markdown documentation for
func1 the function name is
MyModule.InternalMod.func1() and I would prefer to just have