Skip to content

Commit

Permalink
Update docs URLs re: one version & no translations
Browse files Browse the repository at this point in the history
  • Loading branch information
douglatornell committed Apr 19, 2024
1 parent ba9d4d5 commit 0dd9990
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ salishsea.eos.ubc.ca Site
:target: https://black.readthedocs.io/en/stable/
:alt: The uncompromising Python code formatter
.. image:: https://readthedocs.org/projects/salishsea-site/badge/?version=latest
:target: https://salishsea-site.readthedocs.io/en/latest/
:target: https://salishsea-site.readthedocs.io
:alt: Documentation Status
.. image:: https://github.com/SalishSeaCast/salishsea-site/workflows/sphinx-linkcheck/badge.svg
:target: https://github.com/SalishSeaCast/salishsea-site/actions?query=workflow%3Asphinx-linkcheck
Expand All @@ -42,10 +42,10 @@ site where information and research results from various projects about the
oceanography of the Salish Sea are published to the web.

Documentation for the app is in the ``docs/`` directory and is rendered at
https://salishsea-site.readthedocs.io/en/latest/.
https://salishsea-site.readthedocs.io.

.. image:: https://readthedocs.org/projects/salishsea-site/badge/?version=latest
:target: https://salishsea-site.readthedocs.io/en/latest/
:target: https://salishsea-site.readthedocs.io
:alt: Documentation Status


Expand Down
10 changes: 5 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ salishsea.eos.ubc.ca Site Web App
:target: https://black.readthedocs.io/en/stable/
:alt: The uncompromising Python code formatter
.. image:: https://readthedocs.org/projects/salishsea-site/badge/?version=latest
:target: https://salishsea-site.readthedocs.io/en/latest/
:target: https://salishsea-site.readthedocs.io
:alt: Documentation Status
.. image:: https://github.com/SalishSeaCast/salishsea-site/workflows/sphinx-linkcheck/badge.svg
:target: https://github.com/SalishSeaCast/salishsea-site/actions?query=workflow%3Asphinx-linkcheck
Expand Down Expand Up @@ -309,13 +309,13 @@ Building the Documentation
--------------------------

.. image:: https://readthedocs.org/projects/salishsea-site/badge/?version=latest
:target: https://salishsea-site.readthedocs.io/en/latest/
:target: https://salishsea-site.readthedocs.io
:alt: Documentation Status

The documentation for the :kbd:`salishsea-site` package is written in `reStructuredText`_ and converted to HTML using `Sphinx`_.

If you have write access to the `repository`_ on GitHub,
whenever you push changes to GitHub the documentation is automatically re-built and rendered at https://salishsea-site.readthedocs.io/en/latest/.
whenever you push changes to GitHub the documentation is automatically re-built and rendered at https://salishsea-site.readthedocs.io.

Additions,
improvements,
Expand Down Expand Up @@ -383,7 +383,7 @@ The HTML rendering of the docs ends up in :file:`docs/_build/html/`.
You can open the :file:`index.html` file in that directory tree in your browser to preview the results of the build before committing and pushing your changes to Bitbucket.

If you have write access to the `repository`_ on GitHub,
whenever you push changes to GitHub the documentation is automatically re-built and rendered at https://salishsea-site.readthedocs.io/en/latest/.
whenever you push changes to GitHub the documentation is automatically re-built and rendered at https://salishsea-site.readthedocs.io.


.. _SalishSeaSiteLinkCheckingTheDocumentation:
Expand Down Expand Up @@ -419,7 +419,7 @@ The output looks something like::
writing output... [100%] index
(line 21) ok https://docs.python.org/3.8/
(line 21) ok https://black.readthedocs.io/en/stable/
(line 21) ok https://salishsea-site.readthedocs.io/en/latest/
(line 21) ok https://salishsea-site.readthedocs.io
(line 21) ok https://github.com/SalishSeaCast/salishsea-site/actions?query=workflow%3Apytest-with-coverage
(line 21) ok https://www.apache.org/licenses/LICENSE-2.0
(line 48) ok https://salishsea.eos.ubc.ca/
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ version = attr: salishsea_site.__version__
description = salishsea.eos.ubc.ca site web app
author = Doug Latornell
author_email = [email protected]
url = https://salishsea-site.readthedocs.io/en/latest/
url = https://salishsea-site.readthedocs.io
long_description = file: README.rst
license = Apache License, Version 2.0
platform = Linux
Expand Down

0 comments on commit 0dd9990

Please sign in to comment.