docs: use lychee to check link URLs
#3941
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Ok, this should be good to review. Fixed so many broken links 😅 |
mejrs
approved these changes
Mar 8, 2024
Contributing.md
Outdated
| @@ -70,6 +70,12 @@ First, install [`mdbook`][mdbook] and [`nox`][nox]. Then, run | |||
| nox -s build-guide -- --open | |||
| ``` | |||
|
|
|||
| To check all links in the guide are valid, also install [`lychee`][lychee] use the `check-guide` session instead: | |||
There was a problem hiding this comment.
this sentence does not sound quite right
There was a problem hiding this comment.
Good point, I've added "and" - "and use the..."
LilyFoote
approved these changes
Mar 8, 2024
| @@ -43,7 +43,7 @@ The table below contains the Python type and the corresponding function argument | |||
| | `typing.Sequence[T]` | `Vec<T>` | `&PySequence` | | |||
| | `typing.Mapping[K, V]` | `HashMap<K, V>`, `BTreeMap<K, V>`, `hashbrown::HashMap<K, V>`[^3], `indexmap::IndexMap<K, V>`[^4] | `&PyMapping` | | |||
| | `typing.Iterator[Any]` | - | `&PyIterator` | | |||
| | `typing.Union[...]` | See [`#[derive(FromPyObject)]`](traits.html#deriving-a-hrefhttpsdocsrspyo3latestpyo3conversiontraitfrompyobjecthtmlfrompyobjecta-for-enums) | - | | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replaces #3939
lycheeis better maintained and more comprehensive thanmdbook-linkcheck.I was able to get it to run to check the
guidelinks and also the (external) rustdoc links.