Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Apr 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/Documenter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 2 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ makedocs(
"advanced.md",
],
"refindex.md",
]
],
strict = true,
)

deploydocs(
Expand Down
8 changes: 7 additions & 1 deletion docs/src/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
2 changes: 1 addition & 1 deletion docs/src/comm.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ MPI.Intercomm_merge

### Miscellaneous

```
```@docs
MPI.universe_size
MPI.tag_ub
```
12 changes: 7 additions & 5 deletions docs/src/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down Expand Up @@ -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

Expand All @@ -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]
Expand Down
1 change: 0 additions & 1 deletion docs/src/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@ MPI.Is_thread_main
MPI.Initialized
MPI.Finalize
MPI.Finalized
MPI.universe_size
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a duplicate of https://github.com/JuliaParallel/MPI.jl/blob/5cf57d8a289a80f7e550a165863ef0dd40667370/docs/src/comm.md#miscellaneous, I feel like this function is better placed in the communication section, but I'm happy to swap it if you think it's better.

```
18 changes: 0 additions & 18 deletions docs/src/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,11 @@ MPI.Group
MPI.Comparison
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All docstrings I'm removing from this file were added in #521, but these functions/constants never had docstrings.

```

## 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
```
2 changes: 2 additions & 0 deletions docs/src/io.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ MPI.File.get_byte_offset

```@docs
MPI.File.sync
MPI.File.get_atomicity
MPI.File.set_atomicity
```

## Data access
Expand Down
7 changes: 0 additions & 7 deletions docs/src/pointtopoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
MPI.Request
MPI.RequestSet
MPI.Status
MPI.StatusRef
```

### Fields
Expand All @@ -23,12 +22,6 @@ MPI.Status.error::Cint
MPI.Get_count
```

## Constants

```@docs
MPI.STATUS_ZERO
```

## Blocking communication

```@docs
Expand Down