Merge pull request #167 from melexis/urls

Update hyperlinks in README

.github/workflows/python-package.yml

@@ -27,6 +27,9 @@ jobs:
       run: tox -e py
     - name: Build HTML documentation
       run: tox -e docs
+    - name: Checks hyperlinks in documentation
+      if: matrix.python-version == '3.10'
+      run: tox -e docs_linkcheck
     - name: Calculate coverage
       run: tox -e coverage
     - name: Codecov uploader

README.rst

@@ -1,14 +1,14 @@
 .. image:: https://img.shields.io/hexpm/l/plug.svg
-    :target: http://www.apache.org/licenses/LICENSE-2.0
+    :target: https://www.apache.org/licenses/LICENSE-2.0
     :alt: Apache2 License
 
 .. image:: https://github.com/melexis/warnings-plugin/actions/workflows/python-package.yml/badge.svg?branch=master
     :target: https://github.com/melexis/warnings-plugin/actions/workflows/python-package.yml
     :alt: Build status
 
 .. image:: https://badge.fury.io/py/mlx.warnings.svg
-    :target: https://badge.fury.io/py/mlx.warnings
-    :alt: Pypi packaged release
+    :target: https://pypi.org/project/mlx.warnings
+    :alt: PyPI packaged release
 
 .. image:: https://img.shields.io/badge/Documentation-published-brightgreen.svg
     :target: https://melexis.github.io/warnings-plugin/
@@ -19,23 +19,23 @@
     :alt: Coverity Scan Build Status
 
 .. image:: https://codecov.io/gh/melexis/warnings-plugin/branch/master/graph/badge.svg
-    :target: https://codecov.io/gh/melexis/warnings-plugin
+    :target: https://app.codecov.io/gh/melexis/warnings-plugin
     :alt: Code Coverage
 
 .. image:: https://codeclimate.com/github/melexis/warnings-plugin/badges/gpa.svg
     :target: https://codeclimate.com/github/melexis/warnings-plugin
     :alt: Code Climate Status
 
 .. image:: https://codeclimate.com/github/melexis/warnings-plugin/badges/issue_count.svg
-    :target: https://codeclimate.com/github/melexis/warnings-plugin
+    :target: https://codeclimate.com/github/melexis/warnings-plugin/issues
     :alt: Issue Count
 
 .. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
     :target: https://github.com/melexis/warnings-plugin/issues
     :alt: Contributions welcome
 
-.. image:: https://bestpractices.coreinfrastructure.org/projects/4368/badge
-    :target: https://bestpractices.coreinfrastructure.org/projects/4368
+.. image:: https://www.bestpractices.dev/projects/4368/badge
+    :target: https://www.bestpractices.dev/projects/4368
     :alt: CII Best Practices
 
 
@@ -379,7 +379,7 @@ These statuses indicate that you have given due consideration and justified that
 in `Polyspace's documentation about results`_.
 The status "No Action Planned" is not treated differently because this is the default status for annotations.
 
-.. _`Polyspace's documentation about results`: https://nl.mathworks.com/help/polyspace_access/ug/fix-or-comment-polyspace-results-web-browser.html
+.. _`Polyspace's documentation about results`: https://www.mathworks.com/help/polyspace_access/ug/fix-or-comment-polyspace-results-web-browser.html
 
 Example Checks
 ^^^^^^^^^^^^^^

docs/conf.py

@@ -64,6 +64,8 @@
 napoleon_use_rtype = False
 napoleon_use_param = False
 
+linkcheck_ignore = [r'https://www\.mathworks\.com.+']
+
 # Point to plantuml jar file
 # confirm we have plantuml in the path
 if 'nt' in os.name:

tox.ini

@@ -67,6 +67,11 @@ deps =
 commands =
     sphinx-build {posargs:-E} -b doctest docs docs/_build
     sphinx-build {posargs:-E} -b html docs docs/_build
+
+[testenv:docs_linkcheck]
+deps =
+    -r{toxinidir}/docs/requirements.txt
+commands =
     sphinx-build -b linkcheck docs docs/_build
 
 [testenv:check]