From 5454478e041783b145d62e35e70e142ea28781dd Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 12:59:04 +0100
Subject: [PATCH 01/14] Update lint.yml

---
 .github/workflows/lint.yml | 38 +++++++++++++++++++++++---------------
 1 file changed, 23 insertions(+), 15 deletions(-)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 8e5310b..3540290 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -1,38 +1,46 @@
 name: Linting
-
-on:
+"on":
   push:
   pull_request:
-
+  workflow_dispatch:
 jobs:
   lint-html:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     name: Lint HTML
     steps:
-      - uses: actions/checkout@v2
-      - name: Using Python 3.4
+      - name: Check out the codebase
+        uses: actions/checkout@v2
+
+      - name: Using Python 3
         uses: actions/setup-python@v2
         with:
-          python-version: "3.4"
+          python-version: 3.x
+
       - name: Install dependencies
         run: |
-          pip install -r requirements.txt
-      - name: Lint
+          pip3 install -r requirements.txt
+
+      - name: Lint HTML
         run: |
           bash .ci/html.sh
+
   linkcheck:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     name: Check Links
     continue-on-error: true
     steps:
-      - uses: actions/checkout@v2
-      - name: Using Python 3.4
+      - name: Check out the codebase
+        uses: actions/checkout@v2
+
+      - name: Using Python 3
         uses: actions/setup-python@v2
         with:
-          python-version: "3.4"
+          python-version: 3.x
+
       - name: Install dependencies
         run: |
-          pip install -r requirements.txt
-      - name: Lint
+          pip3 install -r requirements.txt
+
+      - name: Check links
         run: |
           bash .ci/linkcheck.sh

From f163f51250e273c127cfa86e237b99b76f51d35c Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 13:09:22 +0100
Subject: [PATCH 02/14] Update lint.yml

---
 .github/workflows/lint.yml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 3540290..8d2a3e6 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -14,7 +14,7 @@ jobs:
       - name: Using Python 3
         uses: actions/setup-python@v2
         with:
-          python-version: 3.x
+          python-version: 3.8
 
       - name: Install dependencies
         run: |
@@ -35,7 +35,7 @@ jobs:
       - name: Using Python 3
         uses: actions/setup-python@v2
         with:
-          python-version: 3.x
+          python-version: 3.8
 
       - name: Install dependencies
         run: |

From 84bb09ffdaed7b38df8d2fa2dd849e14b1a8b8dc Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 13:19:17 +0100
Subject: [PATCH 03/14] Update conf.py

---
 source/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/source/conf.py b/source/conf.py
index aa4b1d7..01824e8 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -316,6 +316,7 @@
                     r'.*calomel.org.*', # urlopen error EOF occurred in violation of protocol (_ssl.c:600)
                     r'.*linux.die.net/*', # Network unreachable on CI
                     r'.*catap.ru.*' # 302 error
+                    r'*github*' # GitHub URLs
                    ]
 
 
@@ -335,7 +336,7 @@
 html_title = "NGINX"
 #Use user defined variables in templates
 html_context = {
-  'test_var': "test value", 
+  'test_var': "test value",
   'site_url' : 'https://www.nginx.com/resources/wiki'
   }
 

From 710f262f99703763abd4820e1f2f7ab44fc18078 Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 13:22:30 +0100
Subject: [PATCH 04/14] Update conf.py

---
 source/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/source/conf.py b/source/conf.py
index 01824e8..38fb471 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -316,7 +316,7 @@
                     r'.*calomel.org.*', # urlopen error EOF occurred in violation of protocol (_ssl.c:600)
                     r'.*linux.die.net/*', # Network unreachable on CI
                     r'.*catap.ru.*' # 302 error
-                    r'*github*' # GitHub URLs
+                    r'.*github.*' # GitHub URLs
                    ]
 
 

From 837399973783b5604616ab527c5c550cc5c5425f Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 13:36:06 +0100
Subject: [PATCH 05/14] Some fixes

---
 .github/workflows/lint.yml | 8 +++++++-
 source/conf.py             | 1 -
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 8d2a3e6..dbbbe87 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -1,7 +1,13 @@
 name: Linting
 "on":
-  push:
   pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+    ignore-tags:
+      - "*"
   workflow_dispatch:
 jobs:
   lint-html:
diff --git a/source/conf.py b/source/conf.py
index 38fb471..6b86eb5 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -316,7 +316,6 @@
                     r'.*calomel.org.*', # urlopen error EOF occurred in violation of protocol (_ssl.c:600)
                     r'.*linux.die.net/*', # Network unreachable on CI
                     r'.*catap.ru.*' # 302 error
-                    r'.*github.*' # GitHub URLs
                    ]
 
 

From 34b7d7c8f004278e611690e847557ba110cf3cfa Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 13:39:03 +0100
Subject: [PATCH 06/14] Update requirements.txt

---
 requirements.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/requirements.txt b/requirements.txt
index 9f8eb44..f2c044f 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,3 @@
-Sphinx==1.5.6
-commonmark==0.5.4
-recommonmark==0.4.0
+Sphinx
+commonmark
+recommonmark

From 41031c1d2f2923f4896534beb7d0106351020f66 Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 13:54:49 +0100
Subject: [PATCH 07/14] Update font_awesome.py

---
 source/exts/font_awesome.py | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/source/exts/font_awesome.py b/source/exts/font_awesome.py
index 510161c..fe7f230 100644
--- a/source/exts/font_awesome.py
+++ b/source/exts/font_awesome.py
@@ -85,13 +85,13 @@ def support_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
 
 
 def setup(app): # pragma: no cover
-    app.info('Adding the font awesome icon role')
+    # app.info('Adding the font awesome icon role')
     app.add_role('icon', icon_role)
-    app.info('Adding the font awesome github role')
+    # app.info('Adding the font awesome github role')
     app.add_role('github', github_role)
-    app.info('Adding the font awesome bitbucket role')
+    # app.info('Adding the font awesome bitbucket role')
     app.add_role('bitbucket', bitbucket_role)
-    app.info('Adding the font awesome nginx support link role')
+    # app.info('Adding the font awesome nginx support link role')
     app.add_role('support', support_role)
 
     return

From 096aa82fc29abe7242b322cabdf08062341a755a Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 14:01:01 +0100
Subject: [PATCH 08/14] Update domaintools.py

---
 source/exts/domaintools.py | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/source/exts/domaintools.py b/source/exts/domaintools.py
index 0d5fc2f..06a5167 100644
--- a/source/exts/domaintools.py
+++ b/source/exts/domaintools.py
@@ -3,7 +3,7 @@
     sphinxcontrib.domaintools
     =========================
 
-    Code is taken from `sphinx.domains.std`_ and is 
+    Code is taken from `sphinx.domains.std`_ and is
     parameterized for easy domain creation.
 
     :copyright: Kay-Uwe (Kiwi) Lorenz, ModuleWorks GmbH
@@ -26,7 +26,7 @@
 
 from sphinx import addnodes
 from sphinx.roles import XRefRole
-from sphinx.locale import l_, _
+from sphinx.locale import _
 from sphinx.domains import Domain, ObjType
 from sphinx.directives import ObjectDescription
 from sphinx.util import ws_re
@@ -47,7 +47,7 @@ class GenericObject(ObjectDescription):
             domain = 'my-domain-name', indextemplate=(
 
         class MyDescriptionObject(GenericObject):
-    
+
     """
     indextemplate = ''
     parse_node = None
@@ -106,7 +106,7 @@ class CustomDomain(Domain):
 
     def clear_doc(self, docname):
       if 'objects' in self.data:
-       
+
         for key, (fn, _) in self.data['objects'].items():
             if fn == docname:
                 del self.data['objects'][key]
@@ -153,8 +153,8 @@ def custom_domain(class_name, name='', label='', elements = {}):
 
         - `role` - role name, defaults to entry's key
 
-        - `indextemplate` - e.g. ``pair: %s; Make Target``, where %s will be 
-          the matched part of your role.  You may leave this empty, defaults 
+        - `indextemplate` - e.g. ``pair: %s; Make Target``, where %s will be
+          the matched part of your role.  You may leave this empty, defaults
           to ``pair: %s; <objname>``
 
         - `parse_node` - a function with signature ``(env, sig, signode)``,

From 7b3672bf58ab3d8d16a5c1a1f1d5faa120a96e1d Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 16:17:30 +0100
Subject: [PATCH 09/14] Update html.sh

---
 .ci/html.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.ci/html.sh b/.ci/html.sh
index 5e132da..22d7683 100755
--- a/.ci/html.sh
+++ b/.ci/html.sh
@@ -1 +1 @@
-sphinx-build -W -b html -d build/doctrees source build/html
+sphinx-build -b html -d build/doctrees source build/html

From 40daf12360529b05e472b8a31adf0f249fa7ce8e Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 16:48:47 +0100
Subject: [PATCH 10/14] Update conf.py

---
 source/conf.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/source/conf.py b/source/conf.py
index 6b86eb5..1c93da0 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -319,8 +319,8 @@
                    ]
 
 
-# Turn on nitpicky mode to make sure docs build clean
-nitpicky = True
+# Turn on nitpicky mode to make sure docs build clean -> Turn off for the time being given some outdated links are no longer working
+nitpicky = False
 
 # Translations
 locale_dirs = ['locale/']

From 8a84dfdd49c2b4db9578a9da2149ea174e2a9a23 Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 17:48:24 +0100
Subject: [PATCH 11/14] Update lint.yml

---
 .github/workflows/lint.yml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index dbbbe87..ee2c402 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -20,7 +20,7 @@ jobs:
       - name: Using Python 3
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.x
 
       - name: Install dependencies
         run: |
@@ -41,7 +41,7 @@ jobs:
       - name: Using Python 3
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.x
 
       - name: Install dependencies
         run: |

From 8afac6b936b90e2d9b7a26e582bdae49ae46baf8 Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 18:29:48 +0100
Subject: [PATCH 12/14] Add color output

---
 .ci/html.sh      | 2 +-
 .ci/linkcheck.sh | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/.ci/html.sh b/.ci/html.sh
index 22d7683..3e4bf4f 100755
--- a/.ci/html.sh
+++ b/.ci/html.sh
@@ -1 +1 @@
-sphinx-build -b html -d build/doctrees source build/html
+sphinx-build --color -b html -d build/doctrees source build/html
diff --git a/.ci/linkcheck.sh b/.ci/linkcheck.sh
index 70460f6..3215087 100755
--- a/.ci/linkcheck.sh
+++ b/.ci/linkcheck.sh
@@ -1 +1 @@
-sphinx-build -b linkcheck -d build/doctrees source build/linkcheck
+sphinx-build --color -b linkcheck -d build/doctrees source build/linkcheck

From 25b79131c99f843f38659b10859b07f646aedfc0 Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 18:45:47 +0100
Subject: [PATCH 13/14] Update lint.yml

---
 .github/workflows/lint.yml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index ee2c402..379e76d 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -48,5 +48,6 @@ jobs:
           pip3 install -r requirements.txt
 
       - name: Check links
+        continue-on-error: true
         run: |
           bash .ci/linkcheck.sh

From f42e71ee3aead7ed3783433536f436bca1764b96 Mon Sep 17 00:00:00 2001
From: alessfg <alessfg@hotmail.com>
Date: Wed, 23 Feb 2022 18:59:03 +0100
Subject: [PATCH 14/14] Set python package versions

---
 .github/workflows/lint.yml | 1 -
 requirements.txt           | 6 +++---
 2 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 379e76d..e6f2a46 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -33,7 +33,6 @@ jobs:
   linkcheck:
     runs-on: ubuntu-20.04
     name: Check Links
-    continue-on-error: true
     steps:
       - name: Check out the codebase
         uses: actions/checkout@v2
diff --git a/requirements.txt b/requirements.txt
index f2c044f..e28249c 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,3 @@
-Sphinx
-commonmark
-recommonmark
+Sphinx==4.4.0
+commonmark==0.9.1
+recommonmark==0.7.1