docs: Add make script (#7)

JuliaLang · Oct 29, 2023 · 8799660 · 8799660
1 parent 0c7ad88
commit 8799660
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 3 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,2 @@
+Manifest.toml
+build/
diff --git a/docs/Project.toml 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
@@ -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
@@ -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