search

JuliaPackaging / Requires.jl

Lazy code loading for Julia
Other
195 stars 28 forks source link

Compatibility with Documenter? #104

Closed henry2004y closed 3 years ago

henry2004y commented 3 years ago

Hello,

I encountered a document generation issue when developing my package. This package contains plotting functionalities from PyPlot.jl, but I don’t want to include that as an explicit dependency, so I choose to use Requires.jl to accomplish the goal. The package import happens in the main source file. This works decent except for the documentation. As can be seen here, there is no documentation for the plotting functions. In the source file, I tried 1. not to specify anything; 2. to use the Pages tag, but neither of these attempts help.

What is the right way to display the documentation here? Would there be a trick in Requires.jl, or may I miss something in Documenter?

henry2004y commented 3 years ago

It appears that I am not familiar with the separate dependency TOML file that Documenter uses. See this post on Discourse.