add auto-generated doc links (#652)

* add auto-generated doc links * prepare new `Clang.jl` patch * add `api.md` * update URLs
JuliaParallel · Sep 30, 2022 · 5a9ed4e · 5a9ed4e
1 parent 3c57167
commit 5a9ed4e
Show file tree

Hide file tree

Showing 5 changed files with 4,470 additions and 1 deletion.
diff --git a/docs/make.jl b/docs/make.jl
@@ -72,6 +72,7 @@ makedocs(
             "reference/topology.md",
             "reference/io.md",
             "reference/advanced.md",
+            "reference/api.md",
         ],
         "refindex.md",
     ],

diff --git a/docs/src/reference/api.md b/docs/src/reference/api.md
@@ -0,0 +1,5 @@
+# API
+
+```@autodocs
+Modules = [MPI.API]
+```
diff --git a/gen/Project.toml b/gen/Project.toml
@@ -8,6 +8,6 @@ MPIPreferences = "3da0fdf6-3ccc-4f1b-acd9-58baa6c99267"
 OpenMPI_jll = "fe0851c0-eecd-5654-98d4-656369965a5c"
 
 [compat]
-Clang = "0.16.2"
+Clang = "0.16.3"
 MPIPreferences = "0.1.3"
 julia = "1.6"
diff --git a/gen/src/MPIgenerator.jl b/gen/src/MPIgenerator.jl
@@ -18,6 +18,13 @@ module MPIgenerator
         mkpath(out)
 
         options = load_options(joinpath(@__DIR__, "generator.toml"))  # wrapper generator options
+        options["general"]["callback_documentation"] = node -> String[
+            """
+            `$(node.id)` man page:
+            - [OpenMPI](https://www.open-mpi.org/doc/current/man3/$(node.id).3.php)
+            - [MPICH](https://www.mpich.org/static/docs/latest/www3/$(node.id).html)
+            """
+        ]
 
         include_dir = normpath(artifact_dir, "include")