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

Move environment YAML file and requirements.txt to new envs/ sub-directory #116

Merged
merged 3 commits into from
Dec 23, 2024

Conversation

douglatornell
Copy link
Member

@douglatornell douglatornell commented Dec 23, 2024

Summary

This Pull Request makes updates to paths for environment setup files and references within documentation and code, ensuring consistency and accuracy. It also includes minor adjustments to file contents to align with these updates.

  • Updated the reference to the environment YAML file in the SalishSeaTools/docs/development.rst and SalishSeaTools/setup.py files to point to the new path (envs/environment-dev.yaml).
  • Adjusted instructions in SalishSeaTools/envs/environment-dev.yaml and SalishSeaTools/envs/requirements.txt to reflect accurate paths and improve clarity.
  • Modified setup.py to reference envs/requirements.txt instead of requirements.txt.
  • Minor syntax and path updates across related files.

Updated paths in documentation and comments to reflect the file move. This
reorganization improves structure by grouping environment-related files
under the `envs` directory.
Moved requirements.txt to the 'envs/' directory for better organization and
clarity. Updated the comment to reflect the new file path for maintaining
dependencies.
This change updates the environment file name to better reflect its purpose
as a development environment configuration. All references in documentation
and related files have been updated accordingly for consistency.
@douglatornell douglatornell added documentation Improvements or additions to documentation SalishSeaTools maintenance Codebase & repo maintenance labels Dec 23, 2024
@douglatornell douglatornell added this to the v24.1 milestone Dec 23, 2024
@douglatornell douglatornell changed the title Envs dir Move environment YAML file and requirements.txt to new envs/ sub-directory Dec 23, 2024
@douglatornell douglatornell merged commit fd03c11 into main Dec 23, 2024
4 checks passed
@douglatornell douglatornell deleted the envs-dir branch December 23, 2024 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Codebase & repo maintenance SalishSeaTools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant