From 3e786a3780db74cdd5c066964577c7a60a24d6f3 Mon Sep 17 00:00:00 2001 From: Doug Latornell Date: Tue, 10 Dec 2024 16:43:46 -0800 Subject: [PATCH] Remove SalishSeaCmd docs and package stub Deleted SalishSeaCmd documentation, README, and filemap, as the package has been maintained in its own repository since late-2016. This cleanup reduces redundancy and improves repository focus. --- SalishSeaCmd/README.rst | 8 -------- SalishSeaCmd/docs/index.rst | 26 -------------------------- SalishSeaCmd_filemap.txt | 28 ---------------------------- docs/SalishSeaCmd | 1 - docs/breaking_changes.rst | 5 +++++ docs/index.rst | 1 - docs/requirements.txt | 8 -------- 7 files changed, 5 insertions(+), 72 deletions(-) delete mode 100644 SalishSeaCmd/README.rst delete mode 100644 SalishSeaCmd/docs/index.rst delete mode 100644 SalishSeaCmd_filemap.txt delete mode 120000 docs/SalishSeaCmd delete mode 100644 docs/requirements.txt diff --git a/SalishSeaCmd/README.rst b/SalishSeaCmd/README.rst deleted file mode 100644 index 3fa57cf83..000000000 --- a/SalishSeaCmd/README.rst +++ /dev/null @@ -1,8 +0,0 @@ -********************************* -Salish Sea NEMO Command Processor -********************************* - -**Note:** This package has been superseded by the standalone SalishSeaCmd package: - -* repo: https://github.com/SalishSeaCast/salishseacmd -* docs: https://salishseacmd.readthedocs.io/en/latest/ diff --git a/SalishSeaCmd/docs/index.rst b/SalishSeaCmd/docs/index.rst deleted file mode 100644 index 14c0b2fa4..000000000 --- a/SalishSeaCmd/docs/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. Copyright 2013-2021 The Salish Sea MEOPAR conttributors -.. and The University of British Columbia -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. https://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. - - -********************************* -Salish Sea NEMO Command Processor -********************************* - -.. note:: - - This package has been superseded by the standalone SalishSeaCmd package: - - * repo: https://github.com/SalishSeaCast/SalishSeaCmd - * docs: https://salishseacmd.readthedocs.io/en/latest/ diff --git a/SalishSeaCmd_filemap.txt b/SalishSeaCmd_filemap.txt deleted file mode 100644 index 6ad6ed687..000000000 --- a/SalishSeaCmd_filemap.txt +++ /dev/null @@ -1,28 +0,0 @@ -# File map for 30-Dec-2016 creation of SalishSeaCmd repo -# from the SalishSeaCmd/ directory of the tools repo. -# -# The following command was used to create the SalishSeaCmd repo: -# cd MEOPAR -# hg convert --filemap tools/SalishSeaCmd_filemap.txt tools SalishSeaCmd - -include .hgtags -include environment-rtd.yml -include LICENSE -include readthedocs.yml -include SalishSeaCmd/ -include SalishSeaCmd_filemap.txt - -rename SalishSeaCmd/docs docs -rename SalishSeaCmd/salishsea_cmd salishsea_cmd -rename SalishSeaCmd/tests tests -rename SalishSeaCmd/.coveragerc .coveragerc -rename SalishSeaCmd/README.rst README.rst -rename SalishSeaCmd/__pkg_metadata__.py __pkg_metadata__.py -rename SalishSeaCmd/environment.yaml environment-dev.yaml -rename SalishSeaCmd/requirements.pip requirements.txt -rename SalishSeaCmd/setup.py setup.py - -include docs/conf.py -include docs/license_description.txt -include docs/Makefile -include docs/_static/ diff --git a/docs/SalishSeaCmd b/docs/SalishSeaCmd deleted file mode 120000 index 86de3f31f..000000000 --- a/docs/SalishSeaCmd +++ /dev/null @@ -1 +0,0 @@ -../SalishSeaCmd/docs \ No newline at end of file diff --git a/docs/breaking_changes.rst b/docs/breaking_changes.rst index e0896c6ce..f0e30e143 100644 --- a/docs/breaking_changes.rst +++ b/docs/breaking_changes.rst @@ -30,6 +30,11 @@ Version 24.1 (unreleased) The following changes that were introduced in version 24.1 of the ``tools`` repository are incompatible with earlier versions: +* Removed docs and package stub for `SalishSeaCmd`_ package. + It was moved into its own repository in late-2016. + + .. _SalishSeaCmd: https://github.com/SalishSeaCast/SalishSeaCmd + * Changed to `CalVer`_ versioning convention. Version identifier format is now ``yy.n[.devn]``, where ``yy`` is the (post-2000) year of release, diff --git a/docs/index.rst b/docs/index.rst index cb1d86d1e..42336b6f0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -41,7 +41,6 @@ Contents: breaking_changes SalishSeaTools/index SOGTools/index - SalishSeaCmd/index SalishSeaNowcast/index netcdf4/index erddap/ERDDAP_datasets.ipynb diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 6fc83f94a..000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,8 +0,0 @@ -# Python packages required by the modules in this repo -# -# This file exists to provide the mock package to facilitate building -# the docs on readthedocs.org where the matplotlib and NumPy C-extensions -# are not supported, -# and in other environments where those packages may not be installed - --e SalishSeaCmd