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

Update docs #2698

Closed
cademirch opened this issue Feb 14, 2024 · 4 comments · Fixed by #2719
Closed

Update docs #2698

cademirch opened this issue Feb 14, 2024 · 4 comments · Fixed by #2719
Labels
bug Something isn't working

Comments

@cademirch
Copy link
Contributor

There have been a number of StackOverflow and Discord posts regarding deprecated options in the docs, particularly cluster execution. Just wanted to start the issue to identify places in the docs that need updating so we can tackle them in a relatively organized way. If you find any, please reply here with a link to docs and what is outdated.

  1. --cluster in the tutorial
@cademirch cademirch added the bug Something isn't working label Feb 14, 2024
@blaiseli
Copy link

blaiseli commented Feb 15, 2024

There is a rather not really helpful link in the following section of de documentation:

https://snakemake.readthedocs.io/en/stable/snakefiles/configuration.html#cluster-configuration-not-supported-anymore

If you click on the link regarding profiles, you get there:

https://snakemake.readthedocs.io/en/stable/getting_started/migration.html#profiles

But this section basically says to look at some documentation about profiles, with a link to the section itself (https://snakemake.readthedocs.io/en/stable/getting_started/migration.html#profiles).

One or more of the above could more usefully refer to: https://snakemake.readthedocs.io/en/latest/executing/cli.html#profiles

@cmeesters
Copy link
Contributor

I am currently updating the docs for the SLURM executor plugin and want to discuss how to merge the (hopefully updated docs) into the main docs, soon.

@pdimens
Copy link

pdimens commented Feb 20, 2024

The snakemake API is also missing from the 8.X docs

@blaiseli
Copy link

This section refers to --cluster, so likely needs some update: https://snakemake.readthedocs.io/en/latest/snakefiles/rules.html#job-properties

johanneskoester pushed a commit that referenced this issue Feb 24, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.5.1](v8.5.0...v8.5.1)
(2024-02-24)


### Documentation

* api docs polishing
([58a6a13](58a6a13))
* fix [#2698](#2698)
([#2714](#2714))
([508080b](508080b))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants