Fix #73 - docs for samael 0.0.19 did not render#87
Open
magikmw wants to merge 1 commit intonjaremko:masterfrom
Open
Fix #73 - docs for samael 0.0.19 did not render#87magikmw wants to merge 1 commit intonjaremko:masterfrom
magikmw wants to merge 1 commit intonjaremko:masterfrom
Conversation
The issue is caused by libxmlsec being unavailable on docs.rs The fix disables docs compilation for xmlsec module entirely. Also bumps dependencies that still used doc_auto_cfg which got merged: rust-lang/rust#138907 Signed-off-by: Michał Walczak <mw@michalwalczak.eu>
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
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.
Fixes #73
The issue is caused by libxmlsec being unavailable on docs.rs
The fix disables docs compilation for xmlsec module entirely while on docs.rs.
It's a naive approach, but I don't know if it can be done any better.
This commit also bumps dependencies that still used doc_auto_cfg which got merged: rust-lang/rust#138907.
I've modified them to the lowest fixed version, and have tested the release build on my machine (can't really get into nix right now).
Let me know it this needs adjustment, I haven't done anything like this before.
I also haven't ran a docs.rs build - I simulated one via
DOCS_RS=true RUSTDOCFLAGS="--cfg docsrs" cargo docs