Access to the documentation while working offline

General Usage
,
1

Hi community! For a couple of weeks, I will have limited access to the internet, and I would like to know if there is a way to get full access to the package documentation offline, especially packages related to DataFrames, Jl, Makie, Statistics, and so on.

I know that I can download the Julia docs to PDF and access the information for the specific functions using the REPL ? keyword. That is good if I know the function’s name, but I would like to access the full documentation so I can read through it. Is there a way to download these documents to PDF?

1 Like
2

The easiest way might be to clone the repos of those projects and build the documentation locally.

2 Likes
3

I see, it would be nice if other libraries follow the Julia base option to download the docs, at least Makie or Dataframes I am thinking.

4

HTTrack allows you to download entire websites to your local computer. I haven’t tried using it for package documentation, but I expect to work easily for this task. Just start at the hosted documentation site, tather than the package repository site.

2 Likes
5

Zeal is a good offline documentation browser IMO, and it comes with a Julia docset. I haven’t used it that much recently, but had a very decent experience with it a few years ago.

1 Like
6

I ended up using it, really nice tool. I tried it on DataFrames.jl, Makie and the Official Julia documentation, for the last 2 took a while (like 40 min and 1 hour respectively), and for dataframes like 5 minutes. For future references

thanks for all the recommendations!

7

Instead of crawling the site, you could also just clone the gh-pages branch of the repo (since 99% of Julia packages host their documentation on GitHub, or equivalently on GitLab).

1 Like