Update installation docs 1.4.1 #1810
Conversation
WalkthroughThis update primarily focuses on changing package management commands from Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://github.com/avatars/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- .conda/README.md (2 hunks)
- .github/workflows/website.yml (2 hunks)
- docs/_static/css/tabs.css (1 hunks)
- docs/conf.py (3 hunks)
- docs/installation.md (6 hunks)
Files skipped from review due to trivial changes (2)
- .conda/README.md
- docs/_static/css/tabs.css
Additional context used
Ruff
docs/conf.py
1-1: UTF-8 encoding declaration is unnecessary (UP009)
Remove unnecessary coding comment
LanguageTool
docs/installation.md
[grammar] ~3-~3: The operating system from Apple is written “macOS” (MAC_OS)
Context: ...a Python package on Windows, Linux, and Mac OS. For quick install using conda, see bel...
[grammar] ~3-~3: The word ‘install’ is not a noun. (A_INSTALL)
Context: ...n Windows, Linux, and Mac OS. For quick install using conda, see below: ````{tabs} ...
[style] ~334-~334: As a shorter alternative for ‘able to’, consider using “can”. (BE_ABLE_TO)
Context: ...nning the diagnostics to see what SLEAP is able to detect on your system: ```bash sleap-d...
[style] ~340-~340: Consider using “unable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...`bash sleap-diagnostic ``` If you were not able to get SLEAP installed, activate the co...
Markdownlint
docs/installation.md
64-64: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
219-219: Expected: fenced; Actual: indented (MD046, code-block-style)
Code block style
238-238: Expected: fenced; Actual: indented (MD046, code-block-style)
Code block style
257-257: Expected: fenced; Actual: indented (MD046, code-block-style)
Code block style
Additional comments not posted (10)
.github/workflows/website.yml (2)
11-11: Update to workflow triggersThe addition of the branch
liezl/update-intallation-docs-1.4.1to the trigger list ensures that any changes pushed to this branch will initiate the build process for the website. This is important for testing changes in a live environment before merging them into the main development or production branches.
45-45: Addition ofsphinx-tabspackage installationInstalling the
sphinx-tabspackage as part of the documentation build process is a good practice. This ensures that the necessary dependencies for rendering tabbed content in the documentation are met, aligning with the changes in documentation structure to include tabs.docs/conf.py (3)
62-62: Addition ofsphinx_tabs.tabsextensionThe inclusion of the
sphinx_tabs.tabsextension is essential for supporting tabbed content in the documentation. This aligns with the PR's objective to introduce tabs in the installation guide, enhancing the organization and readability of the documentation.
177-182: Configuration of CSS for tabsSpecifying
css/tabs.cssin thehtml_css_filesensures that the custom styles for the tabbed interfaces are correctly applied to the HTML output. This customization is important for maintaining a consistent and professional appearance in the documentation.
230-232: Disabling default CSS loading forsphinx_tabsSetting
sphinx_tabs_disable_css_loadingtoTrueis a thoughtful decision to avoid conflicts and redundancy in CSS loading. This ensures that only the theme's CSS is used, which can help in maintaining a cleaner and more streamlined styling in the documentation.
[APROVED]docs/installation.md (5)
3-3: Grammar correction for 'Mac OS'Consider changing "Mac OS" to "macOS" to adhere to Apple's branding guidelines. This is a minor but important detail for maintaining professionalism in documentation.
- SLEAP can be installed as a Python package on Windows, Linux, and Mac OS. + SLEAP can be installed as a Python package on Windows, Linux, and macOS.Tools
LanguageTool
[grammar] ~3-~3: The operating system from Apple is written “macOS” (MAC_OS)
Context: ...a Python package on Windows, Linux, and Mac OS. For quick install using conda, see bel...
[grammar] ~3-~3: The word ‘install’ is not a noun. (A_INSTALL)
Context: ...n Windows, Linux, and Mac OS. For quick install using conda, see below: ````{tabs} ...
5-16: Introduction of tabbed interface for installation commandsThe use of tabs to separate installation commands for different operating systems is a great way to organize content, making it easier for users to find the information that's relevant to them. This aligns with the PR's objectives to improve the clarity and usability of the installation instructions.
26-42: Enhanced user guidance for terminal usageProviding detailed instructions on how to open a terminal on different systems enhances user accessibility and support, especially for those who may be less familiar with these operations. The inclusion of personal preferences and alternatives like Cmder and Windows Terminal is a nice touch that offers additional value to the user.
Line range hint
46-58: Recommendation for package manager usageThe strong recommendation to use Miniconda and guidance on managing multiple conda-based package managers are crucial for preventing installation conflicts and ensuring a smooth setup process. This advice is particularly valuable given the complex dependencies of SLEAP.
Tools
LanguageTool
[grammar] ~3-~3: The operating system from Apple is written “macOS” (MAC_OS)
Context: ...a Python package on Windows, Linux, and Mac OS. For quick install using conda, see bel...
[grammar] ~3-~3: The word ‘install’ is not a noun. (A_INSTALL)
Context: ...n Windows, Linux, and Mac OS. For quick install using conda, see below: ````{tabs} ...
63-182: Comprehensive installation methods and precautionsThe detailed explanation of different installation methods, along with specific commands and conditions for each scenario, provides a thorough guide for users. This section effectively addresses various user needs and scenarios, ensuring that users have all the information they need to successfully install SLEAP.
Tools
Markdownlint
64-64: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
Description
This PR attempts to update and simplify the installation instructions and:
mambacommands withcondamambaandcondacommand interchangeabilityThis PR also attempts to handle the following tasks from
mambaforge is now miniforge-> Recommend miniconda insteadhave 1-line unattended installs-> Link to miniconda installation pageupdate Mac setup to use curl so you don't have to install Xcode (GBs!!)-> Link to miniconda installation pageconda create1-liners in the heading before the TOC!!Types of changes
Does this address any currently open issues?
Outside contributors checklist
Thank you for contributing to SLEAP!
❤️
Summary by CodeRabbit
Documentation
condainstead ofmamba.installation.md.sphinx_tabsextension and associated settings to enhance documentation tabs.Workflow
sphinx-tabsinstallation.