From 87996602f23b860d77772bdada7d618ab0c6ac2f Mon Sep 17 00:00:00 2001 From: Julian Samaroo Date: Sun, 29 Oct 2023 13:09:04 -0700 Subject: [PATCH] docs: Add make script (#7) --- docs/.gitignore | 2 ++ docs/Project.toml | 2 ++ docs/make.jl | 16 ++++++++++++++++ docs/src/index.md | 6 +++--- 4 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 docs/.gitignore create mode 100644 docs/Project.toml create mode 100644 docs/make.jl diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000000000..aea5ba7067ef77 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +Manifest.toml +build/ diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 00000000000000..dfa65cd107d069 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,2 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 00000000000000..9b652caeb9dbbb --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,16 @@ +using Distributed +using Documenter: DocMeta, makedocs, deploydocs + +DocMeta.setdocmeta!(Distributed, :DocTestSetup, :(using Distributed); recursive=true) + +makedocs(; + modules = [Distributed], + sitename = "Distributed", + pages = Any[ + "Distributed" => "index.md", + ], + checkdocs = :exports, + warnonly = [:cross_references], +) + +deploydocs(repo = "github.com/JuliaLang/Distributed.jl.git") diff --git a/docs/src/index.md b/docs/src/index.md index 00b40de49b3960..22d63ceb541396 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,7 +1,7 @@ # [Distributed Computing](@id man-distributed) -Tools for distributed parallel processing. ```@docs +Distributed Distributed.addprocs Distributed.nprocs Distributed.nworkers @@ -31,18 +31,18 @@ Distributed.AbstractWorkerPool Distributed.WorkerPool Distributed.CachingPool Distributed.default_worker_pool -Distributed.clear!(::CachingPool) +Distributed.clear! Distributed.remote Distributed.remotecall(::Any, ::AbstractWorkerPool, ::Any...) Distributed.remotecall_wait(::Any, ::AbstractWorkerPool, ::Any...) Distributed.remotecall_fetch(::Any, ::AbstractWorkerPool, ::Any...) Distributed.remote_do(::Any, ::AbstractWorkerPool, ::Any...) +Distributed.@spawn Distributed.@spawnat Distributed.@fetch Distributed.@fetchfrom Distributed.@distributed Distributed.@everywhere -Distributed.clear!(::Any, ::Any; ::Any) Distributed.remoteref_id Distributed.channel_from_id Distributed.worker_id_from_socket