diff --git a/docs/Project.toml b/docs/Project.toml index 1814eb33..25b0193b 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,5 +1,6 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +Revise = "295af30f-e4ad-537b-8983-00126c2a3abe" [compat] Documenter = "1" diff --git a/docs/make.jl b/docs/make.jl index fe6f908a..e0b9d1c0 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,11 +1,9 @@ using Documenter, Revise -makedocs( +makedocs(; modules = [Revise], - clean = false, - format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"), sitename = "Revise.jl", - authors = "Tim Holy", + authors = "Tim Holy and contributors", linkcheck = !("skiplinks" in ARGS), pages = [ "Home" => "index.md", diff --git a/docs/src/config.md b/docs/src/config.md index 5bcedcfd..1244cd6b 100644 --- a/docs/src/config.md +++ b/docs/src/config.md @@ -85,7 +85,7 @@ There are several ways to set these environment variables: the line containing `using Revise`. - On Unix systems, you can set variables in your shell initialization script (e.g., put lines like `export JULIA_REVISE=manual` in your - [`.bashrc` file](http://www.linuxfromscratch.org/blfs/view/svn/postlfs/profile.html) + [`.bashrc` file](https://www.linuxfromscratch.org/blfs/view/svn/postlfs/profile.html) if you use `bash`). - On Unix systems, you can launch Julia from the Unix prompt as `$ JULIA_REVISE=manual julia` to set options for just that session. @@ -123,7 +123,7 @@ string `"1"` (e.g., `JULIA_REVISE_INCLUDE=1` in a bash script). Revise needs to be notified by your filesystem about changes to your code, which means that the files that define your modules need to be watched for updates. Some systems impose limits on the number of files and directories that can be -watched simultaneously; if such a limit is hit, on Linux this can result in Revise silently ceasing to work +watched simultaneously; if such a limit is hit, on Linux this can result in Revise silently ceasing to work (albeit with unit tests failing) or in a fairly cryptic error like ```sh diff --git a/docs/src/cookbook.md b/docs/src/cookbook.md index bd7f1753..249e3af9 100644 --- a/docs/src/cookbook.md +++ b/docs/src/cookbook.md @@ -5,7 +5,7 @@ For code that might be useful more than once, it's often a good idea to put it in a package. Revise cooperates with the package manager to enforce its distinction between -["versioned" and "under development" packages](https://julialang.github.io/Pkg.jl/v1/managing-packages/); +["versioned" and "under development" packages](https://pkgdocs.julialang.org/v1/managing-packages/); packages that you want to modify and have tracked by `Revise` should be `dev`ed rather than `add`ed. !!! note @@ -17,7 +17,7 @@ packages that you want to modify and have tracked by `Revise` should be `dev`ed In keeping with this spirit, Revise is designed to avoid tracking changes in such files. The correct way to make and track modifications is to `dev` the package. -For creating packages, the author recommends [PkgTemplates.jl](https://github.com/invenia/PkgTemplates.jl). +For creating packages, the author recommends [PkgTemplates.jl](https://github.com/JuliaCI/PkgTemplates.jl). A fallback is to use "plain" `Pkg` commands. Both options are described below. @@ -28,7 +28,7 @@ Both options are described below. this approach might require you to do some configuration. (Once you get things set up, you shouldn't have to do this part ever again.) PkgTemplates needs you to configure your `git` user name and email. - Some instructions on configuration are [here](https://docs.github.com/en/github/getting-started-with-github/set-up-git) + Some instructions on configuration are [here](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) and [here](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup). It's also helpful to sign up for a [GitHub account](https://github.com/) and set git's `github.user` variable. @@ -135,7 +135,7 @@ quite extensively without quitting the Julia session, although there are some [L ### Using Pkg -[Pkg](https://julialang.github.io/Pkg.jl/v1/) works similarly to `PkgTemplates`, +[Pkg](https://pkgdocs.julialang.org/v1/) works similarly to `PkgTemplates`, but requires less configuration while also doing less on your behalf. Let's create a blank `MyPkg` using `Pkg`. (If you tried the `PkgTemplates` version above, you might first have to delete the package with `Pkg.rm("MyPkg")` following by diff --git a/docs/src/internals.md b/docs/src/internals.md index e421ea79..3ff9388b 100644 --- a/docs/src/internals.md +++ b/docs/src/internals.md @@ -34,7 +34,7 @@ because code moves around within the same file. but Revise takes pains to correct these, see below.) Conceptually, Revise implements -[`diff` and `patch`](https://acloudguru.com/blog/engineering/introduction-using-diff-and-patch/) +[`diff` and `patch`](https://opensource.com/article/18/8/diffs-patches) for a running Julia session. Schematically, Revise's inner loop (`revise()`) looks like this: ```julia