Skip to content

Commit

Permalink
Update redirected links in docs
Browse files Browse the repository at this point in the history
Found by sphinx linkcheck.
  • Loading branch information
douglatornell committed Jul 8, 2022
1 parent 53daa1b commit 8e946e9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
13 changes: 7 additions & 6 deletions docs/development.rst
Expand Up @@ -44,7 +44,7 @@
:target: https://github.com/SalishSeaCast/SalishSeaCmd/actions?query=workflow%3ACI
:alt: pytest and test coverage analysis
.. image:: https://codecov.io/gh/SalishSeaCast/SalishSeaCmd/branch/main/graph/badge.svg
:target: https://codecov.io/gh/SalishSeaCast/SalishSeaCmd
:target: https://app.codecov.io/gh/SalishSeaCast/SalishSeaCmd
:alt: Codecov Testing Coverage Report
.. image:: https://github.com/SalishSeaCast/SalishSeaCmd/actions/workflows/codeql-analysis.yaml/badge.svg
:target: https://github.com/SalishSeaCast/SalishSeaCmd/actions?query=workflow:codeql-analysis
Expand Down Expand Up @@ -141,7 +141,7 @@ Coding Style
The :kbd:`SalishSeaCmd` package uses the `black`_ code formatting tool to maintain a coding style that is very close to `PEP 8`_.

.. _black: https://black.readthedocs.io/en/stable/
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
.. _PEP 8: https://peps.python.org/pep-0008/

:command:`black` is installed as part of the :ref:`SalishSeaCmdDevelopmentEnvironment` setup.

Expand Down Expand Up @@ -466,7 +466,7 @@ Continuous Integration
:target: https://github.com/SalishSeaCast/SalishSeaCmd/actions?query=workflow%3ACI
:alt: GitHub Workflow Status
.. image:: https://codecov.io/gh/SalishSeaCast/SalishSeaCmd/branch/main/graph/badge.svg
:target: https://codecov.io/gh/SalishSeaCast/SalishSeaCmd
:target: https://app.codecov.io/gh/SalishSeaCast/SalishSeaCmd
:alt: Codecov Testing Coverage Report

The :kbd:`SalishSeaCmd` package unit test suite is run and a coverage report is generated whenever changes are pushed to GitHub.
Expand All @@ -478,7 +478,7 @@ The testing coverage report is uploaded to `codecov.io`_
.. _repo actions page: https://github.com/SalishSeaCast/SalishSeaCmd/actions
.. _repo commits page: https://github.com/SalishSeaCast/SalishSeaCmd/commits/main
.. _repo code overview page: https://github.com/SalishSeaCast/SalishSeaCmd
.. _codecov.io: https://codecov.io/gh/SalishSeaCast/SalishSeaCmd
.. _codecov.io: https://app.codecov.io/gh/SalishSeaCast/SalishSeaCmd

The `GitHub Actions`_ workflow configuration that defines the continuous integration tasks is in the :file:`.github/workflows/pytest-coverage.yaml` file.

Expand Down Expand Up @@ -520,9 +520,10 @@ License
:target: https://www.apache.org/licenses/LICENSE-2.0
:alt: Licensed under the Apache License, Version 2.0

The SalishSeaCast NEMO command processor and documentation are copyright 2013 – present by the `SalishSeaCast Project Contributors`_ and The University of British Columbia.
The SalishSeaCast NEMO command processor and documentation are copyright 2013 – present
by the `SalishSeaCast Project Contributors`_ and The University of British Columbia.

.. _SalishSeaCast Project Contributors: https://github.com/SalishSeaCast/docs/blob/master/CONTRIBUTORS.rst
.. _SalishSeaCast Project Contributors: https://github.com/SalishSeaCast/docs/blob/main/CONTRIBUTORS.rst

They are licensed under the Apache License, Version 2.0.
https://www.apache.org/licenses/LICENSE-2.0
Expand Down
13 changes: 8 additions & 5 deletions docs/index.rst
Expand Up @@ -24,15 +24,17 @@ SalishSeaCast NEMO Command Processor

The SalishSeaCast NEMO command processor,
:program:`salishsea`,
is a command-line tool for doing various operations associated with the :ref:`SalishSeaNEMO` model.
is a command-line tool for doing various operations associated with the
:ref:`SalishSeaNEMO` model.

The :kbd:`SalishSeaCmd` package is a Python 3 package.
It is developed and tested under Python 3.7 and should work with Python 3.5 and later.

This an extensible tool built on the OpenStack ``cliff``
(`Command Line Interface Formulation Framework`_)
package.
It is a NEMO domain-specific command processor tool for the :ref:`SalishSeaNEMO` that uses plug-ins from the `NEMO-Cmd`_ package.
It is a NEMO domain-specific command processor tool for the :ref:`SalishSeaNEMO`
that uses plug-ins from the `NEMO-Cmd`_ package.

.. _Command Line Interface Formulation Framework: https://docs.openstack.org/cliff/latest/
.. _NEMO-Cmd: https://github.com/SalishSeaCast/NEMO-Cmd
Expand Down Expand Up @@ -62,10 +64,11 @@ Indices and Tables
License
=======

The SalishSeaCmd command processor code and documentation are copyright 2013 – present by the `SalishSeaCast Project Contributors`_ and The University of British Columbia.
The SalishSeaCmd command processor code and documentation are copyright 2013 – present
by the `SalishSeaCast Project Contributors`_ and The University of British Columbia.

.. _SalishSeaCast Project Contributors: https://github.com/SalishSeaCast/docs/blob/master/CONTRIBUTORS.rst
.. _SalishSeaCast Project Contributors: https://github.com/SalishSeaCast/docs/blob/main/CONTRIBUTORS.rst

They are licensed under the Apache License, Version 2.0.
http://www.apache.org/licenses/LICENSE-2.0
https://www.apache.org/licenses/LICENSE-2.0
Please see the LICENSE file for details of the license.

0 comments on commit 8e946e9

Please sign in to comment.