-
Notifications
You must be signed in to change notification settings - Fork 1
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
Remove syn
dependency by relying only on doc = embed_image!
functionality.
#1
Comments
I'd also add that it could be much simplified if this cargo issue was fixed to allow to have dependencies only doc build. |
It was just pointed out to me in the community Discord that This suggests that using |
I'm a bit surprised. Do you have an example where |
@GuillaumeGomez: I'm just going by the word of @Nemo157 here, to be honest. I don't have an explicit example myself, unfortunately. |
Ah right, |
Currently,
syn
is only necessary for theembed_doc_image
attribute. Although the#[embed_doc_image]
also works on older Rust versions, it seems like a reasonable trade-off to only be able to generate docs for Rust > 1.54. Then we can remove#[embed_doc_image]
as well assyn
. The remaining dependencies are hopefully lightweight enough that most users won't need to disable them during non-doc compilation.We should also simplify documentation to focus on the case when Rust >= 1.54 - in which case using
embed-doc-image
is easy, and put less emphasis on all the workarounds for making code compile on Rust < 1.54 (although still discuss them).Additionally, as suggested by @GuillaumeGomez here, we can use
cfg(doc)
to ensure thatembed_image!
evaluates to a no-op when not compiling docs.Finally, we should also provide an
enabled
feature that, when not enabled, makes the whole crate a no-op with no dependencies. This way it's possible for users to only embed doc images when a feature, and otherwise pay no price whatsoever when the feature is not enabled.The text was updated successfully, but these errors were encountered: