How to include the docstring for a function from another package in my Julia docs?

user_7619808 0
Viewed 169

I have a function defined in a different package which I include and then export from my Julia package. I now want to include the docs for that function in my docs using Documenter.jl. What sort of @ref syntax would I need to do this? The documenter docs don't seem to covet this use case.

julia
1 Answers

That is what we do in MeasureTheory, feel free to take a look at https://github.com/cscherrer/MeasureTheory.jl/blob/master/docs/make.jl. Our goal was to include docstrings from MeasureBase as well, and all it takes are some tweaks to the make.jl file:

  • include both packages in the modules argument to makedocs
  • setup doctests for both packages

Note that MeasureTheory re-exports MeasureBase, otherwise we would need to add using MeasureBase at the start of the file too.

user_153737920
Related