Update installation docs 1.4.1
Description
This PR attempts to update and simplify the installation instructions and:
- [x] removes the installation instructions for other package managers and instead links out the package manager installation page
- [x] changes the mambaforge installation recommendation back to miniconda (which now sets the solver to libmamba by default for newer installations)
- [x] replaces all
mambacommands withconda - [x] adds a note about
mambaandcondacommand interchangeability - [x] uses tabs for installation methods (conda from package, conda from source, pip), operating system (Windows and Linux, Mac OS), and also (NVIDIA GPU, CPU or other GPU)
This PR also attempts to handle the following tasks from
- #1778
- [ ] Simplify and modernize installation page
- [ ] ~~mambaforge is now miniforge~~ -> Recommend miniconda instead
- [ ] ~~have 1-line unattended installs~~ -> Link to miniconda installation page
- [ ] ~~update Mac setup to use curl so you don't have to install Xcode (GBs!!)~~ -> Link to miniconda installation page
- [x]
conda create1-liners in the heading before the TOC!! - [ ] Backwards compatibility: add guide for installing <1.4.0 after the conda package label switchover (@eberrigan)
Types of changes
- [ ] Bugfix
- [ ] New feature
- [ ] Refactor / Code style update (no logical changes)
- [ ] Build / CI changes
- [x] Documentation Update
- [ ] Other (explain)
Does this address any currently open issues?
- #1778
Outside contributors checklist
- [ ] Review the guidelines for contributing to this repository
- [ ] Read and sign the CLA and add yourself to the authors list
- [ ] Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
- [ ] Add tests that prove your fix is effective or that your feature works
- [ ] Add necessary documentation (if appropriate)
Thank you for contributing to SLEAP!
:heart:
Summary by CodeRabbit
-
Documentation
- Updated installation commands in documentation to use
condainstead ofmamba. - Refined and clarified installation instructions for SLEAP in
installation.md. - Added styles for a tabbed interface in documentation.
- Included
sphinx_tabsextension and associated settings to enhance documentation tabs.
- Updated installation commands in documentation to use
-
Workflow
- Updated GitHub workflow to trigger on a specific branch and added
sphinx-tabsinstallation.
- Updated GitHub workflow to trigger on a specific branch and added
Walkthrough
This update primarily focuses on changing package management commands from mamba to conda within the .conda/README.md file. It also modifies the GitHub Actions workflow trigger, introduces the sphinx-tabs extension for documentation, adds styling for tabbed interfaces in the docs, and refines version constraints in dev_requirements.txt. Additionally, the installation instructions in docs/installation.md have been streamlined and clarified.
Changes
| Files/Paths | Change Summaries |
|---|---|
.conda/README.md |
Updated commands from mamba to conda for environment creation/installation. |
.github/workflows/website.yml |
Modified branch trigger and removed comments related to myst_nb and lxml. |
dev_requirements.txt |
Updated version constraints for dependencies and added new packages. |
docs/_static/css/tabs.css |
Introduced styling for tabs, defining appearance and behavior. |
docs/conf.py |
Added sphinx_tabs.tabs, updated CSS files, and settings for tabbed content. |
docs/installation.md |
Streamlined installation instructions, emphasizing conda over mamba. |
Poem
🌟 In code's quiet dance, a change so grand,
mambasteps back,condatakes the stand.
Tabs now gleam with a stylish twist,
Clearer paths in docs, not to be missed!
🐰 With code so sleek, the future we kissed.
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai generate interesting stats about this repository and render them as a table.@coderabbitai show all the console.log statements in this repository.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 75.33%. Comparing base (
7ed1229) to head (87d05b4). Report is 47 commits behind head on develop.
Additional details and impacted files
@@ Coverage Diff @@
## develop #1810 +/- ##
===========================================
+ Coverage 73.30% 75.33% +2.02%
===========================================
Files 134 133 -1
Lines 24087 24476 +389
===========================================
+ Hits 17658 18440 +782
+ Misses 6429 6036 -393
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.