Merge pull request #569 from giordano/mg/docs

[docs] Fix broken links and remove references to non-existing docstrings

Author: giordano

.github/workflows/Documenter.yml

@@ -31,4 +31,4 @@ jobs:
       - name: Build and deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: julia --project=docs/ docs/make.jl
+        run: julia --color=yes --project=docs/ docs/make.jl

docs/make.jl

@@ -72,7 +72,8 @@ makedocs(
             "advanced.md",
         ],
         "refindex.md",
-    ]
+    ],
+    strict = true,
 )
 
 deploydocs(

docs/src/advanced.md

@@ -37,7 +37,13 @@ MPI.infoval
 ## Error handler objects
 
 ```@docs
-MPI.ErrorHandler
+MPI.Errhandler
 MPI.get_errorhandler
 MPI.set_errorhandler!
 ```
+
+## Miscellaneous
+
+```@docs
+MPI.Consts.@const_ref
+```

docs/src/comm.md

@@ -46,7 +46,7 @@ MPI.Intercomm_merge
 
 ### Miscellaneous
 
-```
+```@docs
 MPI.universe_size
 MPI.tag_ub
 ```

docs/src/configuration.md

@@ -55,8 +55,9 @@ allow the user to choose which MPI implementation to use for a project. This pro
 a single source of truth that can be used for JLL packages (Julia packages providing C libraries)
 that link against MPI, localizes the choice of MPI implementation to a project.
 
-Users can use the provided [`use_system_binary`](@ref) or [`use_jll_binary`](@ref)
-to switch MPI implementations. By default, the JLL-provided binaries are used.
+Users can use the provided [`use_system_binary`](@ref MPIPreferences.use_system_binary) or
+[`use_jll_binary`](@ref MPIPreferences.use_jll_binary) to switch MPI implementations. By
+default, the JLL-provided binaries are used.
 
 ### Migration from MPI.jl `v0.19`
 
@@ -106,8 +107,8 @@ The following MPI implementations should work out-of-the-box with MPI.jl:
 - [Cray MPICH](https://docs.nersc.gov/development/compilers/wrappers/)
 - [Fujitsu MPI](https://www.fujitsu.com/global/about/resources/publications/technicalreview/2020-03/article07.html#cap-03)
 
-If the implementation is changed, you will need to use [`MPI.use_system_binary()`](@ref) or
-[`MPI.use_jll_binary()`](@ref).
+If the implementation is changed, you will need to use [`MPI.use_system_binary()`](@ref MPIPreferences.use_system_binary)
+or [`MPI.use_jll_binary()`](@ref MPIPreferences.use_jll_binary).
 
 #### Advanced options
 
@@ -129,7 +130,8 @@ but also open an issue such that the automatic detection can be improved.
 Preferences are merged across the Julia load path, such that it is feasible to provide a module file that appends a path to
 `JULIA_LOAD_PATH` variable that contains system-wide preferences.
 
-As an example you can use [`MPI.use_system_binary()`](@ref) to create a file `LocalPreferences.toml` containing:
+As an example you can use [`MPI.use_system_binary()`](@ref MPIPreferences.use_system_binary)
+to create a file `LocalPreferences.toml` containing:
 
 ```toml
 [MPIPreferences]

docs/src/environment.md

@@ -23,5 +23,4 @@ MPI.Is_thread_main
 MPI.Initialized
 MPI.Finalize
 MPI.Finalized
-MPI.universe_size
 ```

docs/src/group.md

@@ -11,29 +11,11 @@ MPI.Group
 MPI.Comparison
 ```
 
-## Constants
-
-```@docs
-MPI.GROUP_NULL
-MPI.GROUP_EMPTY
-```
-
 ## Functions
 
 ### Operations
 
 ```@docs
 MPI.Group_size
 MPI.Group_rank
-MPI.Group_compare
-```
-
-### Constructors
-
-```@docs
-MPI.Group_difference
-MPI.Group_intersection
-MPI.Group_union
-MPI.Group_excl
-MPI.Group_incl
 ```

docs/src/io.md

@@ -17,6 +17,8 @@ MPI.File.get_byte_offset
 
 ```@docs
 MPI.File.sync
+MPI.File.get_atomicity
+MPI.File.set_atomicity
 ```
 
 ## Data access

docs/src/pointtopoint.md

@@ -6,7 +6,6 @@
 MPI.Request
 MPI.RequestSet
 MPI.Status
-MPI.StatusRef
 ```
 
 ### Fields
@@ -23,12 +22,6 @@ MPI.Status.error::Cint
 MPI.Get_count
 ```
 
-## Constants
-
-```@docs
-MPI.STATUS_ZERO
-```
-
 ## Blocking communication
 
 ```@docs