diff --git a/.github/workflows/Documenter.yml b/.github/workflows/Documenter.yml index 9bc99f9fe..fe5d53daf 100644 --- a/.github/workflows/Documenter.yml +++ b/.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 diff --git a/docs/make.jl b/docs/make.jl index 447d7da58..7da4dfd60 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -72,7 +72,8 @@ makedocs( "advanced.md", ], "refindex.md", - ] + ], + strict = true, ) deploydocs( diff --git a/docs/src/advanced.md b/docs/src/advanced.md index 192da13c2..77cf76eca 100644 --- a/docs/src/advanced.md +++ b/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 +``` diff --git a/docs/src/comm.md b/docs/src/comm.md index 9db5ec1b0..1c4c3e65a 100644 --- a/docs/src/comm.md +++ b/docs/src/comm.md @@ -46,7 +46,7 @@ MPI.Intercomm_merge ### Miscellaneous -``` +```@docs MPI.universe_size MPI.tag_ub ``` diff --git a/docs/src/configuration.md b/docs/src/configuration.md index d56b965ba..d3d5c4cf2 100644 --- a/docs/src/configuration.md +++ b/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] diff --git a/docs/src/environment.md b/docs/src/environment.md index 31d95f5f2..c09f23a7c 100644 --- a/docs/src/environment.md +++ b/docs/src/environment.md @@ -23,5 +23,4 @@ MPI.Is_thread_main MPI.Initialized MPI.Finalize MPI.Finalized -MPI.universe_size ``` diff --git a/docs/src/group.md b/docs/src/group.md index fdd52cdaf..11768803c 100644 --- a/docs/src/group.md +++ b/docs/src/group.md @@ -11,13 +11,6 @@ MPI.Group MPI.Comparison ``` -## Constants - -```@docs -MPI.GROUP_NULL -MPI.GROUP_EMPTY -``` - ## Functions ### Operations @@ -25,15 +18,4 @@ MPI.GROUP_EMPTY ```@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 ``` diff --git a/docs/src/io.md b/docs/src/io.md index 2279044c9..ec0019562 100644 --- a/docs/src/io.md +++ b/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 diff --git a/docs/src/pointtopoint.md b/docs/src/pointtopoint.md index c59e54fd7..4bcfe2a2e 100644 --- a/docs/src/pointtopoint.md +++ b/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