Skip to content

Commit

Permalink
Add warning about Rust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
romainthomas committed Jul 21, 2024
1 parent ad4e824 commit 38b7f92
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions doc/sphinx/api/rust/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,13 @@
[dependencies]
lief = { git = "https://github.com/lief-project/LIEF", branch = "main" }
The API is documented here: https://docs.rs/crate/lief/latest and the nightly
documentation is available here: https://lief-rs.s3.fr-par.scw.cloud/doc/latest/lief/index.html
.. warning::

LIEF rust bindings are not on ``docs.rs`` because of network restrictions:
https://github.com/rust-lang/docs.rs/issues/2563

The API is documented here https://lief-rs.s3.fr-par.scw.cloud/doc/latest/lief/index.html

Precompiled FFI Bindings
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 38b7f92

Please sign in to comment.