Make guides from doc/*.md available through docs.rs and offline docs #1869
Conversation
This file contains hidden or 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
…docs doc/**.md, changing hardcoded links of crate item docs from https:/docs.rs to internal rustdoc references
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hello,
I often work offline and rely on offline documentation of dependency crates via
cargo doc --openbut because nom's rustdoc currently points to github.com for guides I ended up having to clone the nom git repo to my machine and keep switching between browsing nom's API reference via rustdoc and reading markdown files without the nice web rendering.Then I resolved to give a try to include the "loose" markdown files from
doc/*.mdin the crate's rustdoc and am quite satisfied at the result. I believe that other nom users might enjoy the same approach, so I resolved to send this PR.I deliberately did not squash the commits so anyone can see the approach I took to get it all done via shell-script automation 👼 but I am glad to do just so if you like the end result.