Skip to content
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

docs: Mention required openssl dep for rust-script #1216

Merged
merged 2 commits into from Oct 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/snakefiles/rules.rst
Expand Up @@ -744,10 +744,11 @@ Rust_
script:
"path/to/script.rs"

The ability to execute Rust scripts is facilitated by |rust-script|_. As such, the
script must be a valid ``rust-script`` script and ``rust-script`` must be available in the
environment the rule is run in.
The minimum required ``rust-script`` version is `1.15.0`, so in the example above, the contents of ``rust.yaml`` might look like this:
The ability to execute Rust scripts is facilitated by |rust-script|_.
As such, the script must be a valid ``rust-script`` script and ``rust-script``
(plus OpenSSL and a C compiler toolchain, provided by Conda packages ``openssl``, ``c-compiler``, ``pkg-config``)
must be available in the environment the rule is run in.
The minimum required ``rust-script`` version is 1.15.0, so in the example above, the contents of ``rust.yaml`` might look like this:

.. code block:: yaml

Expand All @@ -756,6 +757,9 @@ The minimum required ``rust-script`` version is `1.15.0`, so in the example abov
- bioconda
dependencies:
- rust-script>=0.15.0
- openssl
- c-compiler
- pkg-config



Expand Down
1 change: 1 addition & 0 deletions tests/test_conda/test-env.yaml
Expand Up @@ -3,3 +3,4 @@ channels:
- conda-forge
dependencies:
- melt ==1.0.3
- python <3.10
3 changes: 3 additions & 0 deletions tests/test_script/envs/rust.yaml
Expand Up @@ -3,3 +3,6 @@ channels:
- bioconda
dependencies:
- rust-script>=0.15.0
- openssl
- c-compiler
- pkg-config