I’m creating documentation for a package using Documenter.jl , and I’m loving the efficiency that the @docs macro provides.
However, in trying to make my documentation as user friendly as possible, I’ve hit a snag.
When I add this to my markdown file:
` ` `@docs MyPackage.b ` ` `
the function syntax text that gets published in the respective html file looks like this:
where the source docstring is, when instead I want it to look like this:
As I want users of my package to call
MyPackage.b(), or just
b(), is there a way to exclude the inner module name (
B) using Documenter?
I’ve played around with the main package module, trying to @reexport the function b from B to MyPackage directly, but as the original docstring belongs to a function (b) in the inner module B, it doesn’t solve my problem.
If it’s any help, the main package module looks something like this:
module MyPackage export b include("./B.jl") using .B: b end
If anyone can offer a solution, I would be soooooo grateful