Skip to content

Commit

Permalink
Remove SalishSeaNowcast docs and package stub (#111)
Browse files Browse the repository at this point in the history
Deleted the SalishSeaNowcast package stub and documentation, as the package has
been maintained in a separate repository since late-2016. Adjusted remaining
documentation to reflect this change and updated relevant sections to remove
obsolete links or mentions.
  • Loading branch information
douglatornell authored Dec 13, 2024
1 parent 66b907f commit be1639f
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 40 deletions.
8 changes: 0 additions & 8 deletions SalishSeaNowcast/README.rst

This file was deleted.

28 changes: 0 additions & 28 deletions SalishSeaNowcast/docs/index.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/SalishSeaNowcast

This file was deleted.

5 changes: 5 additions & 0 deletions docs/breaking_changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 `SalishSeaNowcast`_ package.
It was moved into its own repository in late-2016.

.. _SalishSeaNowcast: https://github.com/SalishSeaCast/SalishSeaNowcast

* Removed docs and package stub for `SalishSeaCmd`_ package.
It was moved into its own repository in late-2016.

Expand Down
1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ Contents:
breaking_changes
SalishSeaTools/index
SOGTools/index
SalishSeaNowcast/index
netcdf4/index
erddap/ERDDAP_datasets.ipynb
visualisation/visualization_workflows_xarray.ipynb
Expand Down
2 changes: 1 addition & 1 deletion docs/python_packaging/hg_named_branches.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ and abandoned.
Examples of the use of named branches in the :ref:`tools-repo` include:

* Development of v2.0 of the :ref:`SalishSeaCmdProcessor` to support NEMO-3.6 in the :kbd:`SalishSeaCmd-3.6` branch
* Separation of the nowcast system code from the :ref:`SalishSeaToolsPackage` into the :ref:`SalishSeaNowcastPackage` in the :kbd:`SalishSeaNowcast` branch
* Separation of the nowcast system code from the :ref:`SalishSeaToolsPackage` into the :kbd:`SalishSeaNowcastPackage` in the :kbd:`SalishSeaNowcast` branch
* Refactoring of the nowcast system web page results figures into a 1 figure per module architecture in the :kbd:`refactor-nowcast-figures` branch

There is a brief description of the key elements of `working with named branches`_ in the Mercurial docs,
Expand Down
2 changes: 1 addition & 1 deletion docs/python_packaging/library_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ maintain,
and improve.
While much of what follows is applicable to any Python code that you may write,
some of the points are particularly relevant to code going into modules in the :ref:`tools-repo`;
e.g. the :ref:`SalishSeaToolsPackage` and the :ref:`SalishSeaNowcastPackage`.
e.g. the :ref:`SalishSeaToolsPackage`.

A primary guide for writing Python code is `PEP 8 -- Style Guide for Python Code`_.

Expand Down

0 comments on commit be1639f

Please sign in to comment.