diff --git a/docs/make.jl b/docs/make.jl index 6806a137..9783f2ae 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,7 +1,9 @@ using Documenter, Gtk makedocs( - format = Documenter.HTML(), + format = Documenter.HTML( + prettyurls = get(ENV, "CI", nothing) == "true" + ), modules = [Gtk], sitename = "Gtk.jl", authors = "...", diff --git a/docs/src/doc/precompilation.md b/docs/src/doc/precompilation.md deleted file mode 100644 index c0ce37bd..00000000 --- a/docs/src/doc/precompilation.md +++ /dev/null @@ -1,19 +0,0 @@ -# Precompilation - -For this to work, you need to be building Julia from source, and you need to be using -at least Julia version 0.3. - -In your Julia `base/` directory, create (or append to) a file called `userimg.jl` the line - - require("Gtk") - -Then build Julia as you normally would; the Gtk module will be available when julia starts. - -In some cases, it might be necessary to add the path to the folder containing the Gtk shared libraries, for example: - - push!(DL_LOAD_PATH, "/usr/lib/x86_64-linux_gnu") - require("Gtk") - pop!(DL_LOAD_PATH) - -The `"/usr/lib/x86_64-linux_gnu"` needs to be replaced with the location of the GTK libraries on your system. -However, when the library is in a standard location -- such as `/usr/lib`, `/usr/local/lib`, or `/usr/lib/x86_64-linux_gnu` (on some systems) -- this step can be skipped. \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index fa7e3b04..b0ea3191 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -17,9 +17,24 @@ using Pkg Pkg.add("Gtk") ``` +!!! tip + On some platforms, you may see messages like + + > Gtk-Message: 20:15:48.288: Failed to load module "canberra-gtk-module" + + These are harmless. If you want to suppress them, on Unix platforms you can add something like + + ```bash + export GTK_PATH=$GTK_PATH:/usr/lib/x86_64-linux-gnu/gtk-3.0 + ``` + + to your `.bashrc` file. (You may need to customize the path for your system; it should have a `modules` directory containing `libcanberra`.) + ## Precompilation -Gtk is precompilable by normal mechanisms. For further reduction of startup time for applications that use Gtk, one can even [build it into your local installation of julia](doc/precompilation.md). +Gtk is precompilable by normal mechanisms. Julia 1.6 or higher is recommended as having much shorter load times than earlier Julia versions. + +On very old Julia versions, you can use [PackageCompiler](https://github.com/JuliaLang/PackageCompiler.jl). Be aware that this has [downsides](https://julialang.github.io/PackageCompiler.jl/dev/sysimages/#Drawbacks-to-custom-sysimages-1) and should not be necessary on modern versions of Julia. ## Usage