Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Names are not picked up by Documenter.jl #38

Open
fonsp opened this issue Dec 10, 2021 · 0 comments
Open

Names are not picked up by Documenter.jl #38

fonsp opened this issue Dec 10, 2021 · 0 comments

Comments

@fonsp
Copy link

fonsp commented Dec 10, 2021

Any globals inserted into my main module are not automatically rendered when I use autodocs

MWE is a package like:

module Example
using Reexport

@reexport module Sub
export greet
greet(x) = "Hello $x"
end
end

With docs/make.jl

using Documenter

makedocs(;
    sitename = "Example",
    modules = [Example]
)

and docs/src/index.md:

# Example.jl

``\`@meta
CurrentModule = Example
``\`

``\`@autodocs
Modules = [Example]
Order   = [:function, :type]
``\`

Adding

Modules = [Example, Example.Sub]

does not help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant