Fix GitHub actions

.ci/html.sh

@@ -1 +1 @@
-sphinx-build -W -b html -d build/doctrees source build/html
+sphinx-build --color -b html -d build/doctrees source build/html

.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

.github/workflows/lint.yml

@@ -1,38 +1,52 @@
 name: Linting
-
-on:
-  push:
+"on":
   pull_request:
-
+    branches:
+      - master
+  push:
+    branches:
+      - master
+    ignore-tags:
+      - "*"
+  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
+        continue-on-error: true
         run: |
           bash .ci/linkcheck.sh

requirements.txt

@@ -1,3 +1,3 @@
-Sphinx==1.5.6
-commonmark==0.5.4
-recommonmark==0.4.0
+Sphinx==4.4.0
+commonmark==0.9.1
+recommonmark==0.7.1

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/']
@@ -335,7 +335,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'
   }
 

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)``,

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