Access package documentation in REPL

Is there some way to view the package documentation from the REPL? If I use the help mode I get the following for an example:

julia> using TimeSeries
[ Info: Precompiling TimeSeries [9e3dc215-6440-5c97-bce1-76c03772f85e]

help?> TimeSeries
search: TimeSeries AbstractTimeSeries

No documentation found.

No docstring found for module TimeSeries.

It seems that the packages/ folder in the .julia/ folder includes the source for the documentation for all packages. Is there a way to generate a locally viewable copy of the documentation?

Another thing that would be nice is the ability to view and search all the packages added to your .julia. Of specific utility would be showing the package corresponding to various methods so that you could select the package docs rather than getting the few lines of description of a method that give little context to what, where, or how it is to be used.

I’m still new to Julia so it is possible I’ve missed how to do this. It would be a nice feature to have and would improve the discoverability of Julia functionality.

You can access docstrings with ? — while packages are encouraged to provide one for modules, they may not have got around to it.

You can pkg> dev the package (this is needed as package directories may be read only), and run the make.jl in the docs directory. See the docs.

This would be nice, but would also require an indexed database to be built and updated locally. I recommend grep-like a tool like

or just

1 Like

You can access docstrings with ? — while packages are encouraged to provide one for modules, they may not have got around to it.

How does on document a module with docstrings? I found documentation for functions, methods, types,… but nothing for modules.

I’ve been using juliahub to find the online documentation for packages but options for smarter/more-global package documentation in the REPL is limited by the lack of any such documentation. Even something as simple as a minimal module/package documentation with just the link to the online documentation would be a huge improvement in discoverability and accessibility of documentation.

Thanks for your reply and tips about manual build of a local copy of documentation.

Docstrings can be for modules too. It’s actually a really useful feature that more packages should have.

Thanks to @tim.holy, VideoIO now has one with a few pointers.

i.e. ? VideoIO

2 Likes

100% agree. That looks like a very good example as well.

Every now and again we discuss having default docstrings for the main module of packages such that if they do not have explict docstrings thern the README.md is shown.

1 Like

I saw this trick for including the REAMDE as a docstring in @tkf’s packages:

1 Like

I PR’ed the basic idea Show readme if available, if module is missing a docstring by ianshmean · Pull Request #39093 · JuliaLang/julia · GitHub

4 Likes