Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings
This repository was archived by the owner on Jul 6, 2023. It is now read-only.

Commit 785c0cf

Browse files
authored
Fix GitHub actions (#590)
1 parent 0cc3202 commit 785c0cf

File tree

7 files changed

+49
-35
lines changed

7 files changed

+49
-35
lines changed

‎.ci/html.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
sphinx-build -W -b html -d build/doctrees source build/html
1+
sphinx-build --color -b html -d build/doctrees source build/html

‎.ci/linkcheck.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
sphinx-build -b linkcheck -d build/doctrees source build/linkcheck
1+
sphinx-build --color -b linkcheck -d build/doctrees source build/linkcheck

‎.github/workflows/lint.yml‎

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,52 @@
11
name: Linting
2-
3-
on:
4-
push:
2+
"on":
53
pull_request:
6-
4+
branches:
5+
- master
6+
push:
7+
branches:
8+
- master
9+
ignore-tags:
10+
- "*"
11+
workflow_dispatch:
712
jobs:
813
lint-html:
9-
runs-on: ubuntu-18.04
14+
runs-on: ubuntu-20.04
1015
name: Lint HTML
1116
steps:
12-
- uses: actions/checkout@v2
13-
- name: Using Python 3.4
17+
- name: Check out the codebase
18+
uses: actions/checkout@v2
19+
20+
- name: Using Python 3
1421
uses: actions/setup-python@v2
1522
with:
16-
python-version: "3.4"
23+
python-version: 3.x
24+
1725
- name: Install dependencies
1826
run: |
19-
pip install -r requirements.txt
20-
- name: Lint
27+
pip3 install -r requirements.txt
28+
29+
- name: Lint HTML
2130
run: |
2231
bash .ci/html.sh
32+
2333
linkcheck:
24-
runs-on: ubuntu-18.04
34+
runs-on: ubuntu-20.04
2535
name: Check Links
26-
continue-on-error: true
2736
steps:
28-
- uses: actions/checkout@v2
29-
- name: Using Python 3.4
37+
- name: Check out the codebase
38+
uses: actions/checkout@v2
39+
40+
- name: Using Python 3
3041
uses: actions/setup-python@v2
3142
with:
32-
python-version: "3.4"
43+
python-version: 3.x
44+
3345
- name: Install dependencies
3446
run: |
35-
pip install -r requirements.txt
36-
- name: Lint
47+
pip3 install -r requirements.txt
48+
49+
- name: Check links
50+
continue-on-error: true
3751
run: |
3852
bash .ci/linkcheck.sh

‎requirements.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Sphinx==1.5.6
2-
commonmark==0.5.4
3-
recommonmark==0.4.0
1+
Sphinx==4.4.0
2+
commonmark==0.9.1
3+
recommonmark==0.7.1

‎source/conf.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -319,8 +319,8 @@
319319
]
320320

321321

322-
# Turn on nitpicky mode to make sure docs build clean
323-
nitpicky = True
322+
# Turn on nitpicky mode to make sure docs build clean -> Turn off for the time being given some outdated links are no longer working
323+
nitpicky = False
324324

325325
# Translations
326326
locale_dirs = ['locale/']
@@ -335,7 +335,7 @@
335335
html_title = "NGINX"
336336
#Use user defined variables in templates
337337
html_context = {
338-
'test_var': "test value",
338+
'test_var': "test value",
339339
'site_url' : 'https://www.nginx.com/resources/wiki'
340340
}
341341

‎source/exts/domaintools.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
sphinxcontrib.domaintools
44
=========================
55
6-
Code is taken from `sphinx.domains.std`_ and is
6+
Code is taken from `sphinx.domains.std`_ and is
77
parameterized for easy domain creation.
88
99
:copyright: Kay-Uwe (Kiwi) Lorenz, ModuleWorks GmbH
@@ -26,7 +26,7 @@
2626

2727
from sphinx import addnodes
2828
from sphinx.roles import XRefRole
29-
from sphinx.locale import l_, _
29+
from sphinx.locale import _
3030
from sphinx.domains import Domain, ObjType
3131
from sphinx.directives import ObjectDescription
3232
from sphinx.util import ws_re
@@ -47,7 +47,7 @@ class GenericObject(ObjectDescription):
4747
domain = 'my-domain-name', indextemplate=(
4848
4949
class MyDescriptionObject(GenericObject):
50-
50+
5151
"""
5252
indextemplate = ''
5353
parse_node = None
@@ -106,7 +106,7 @@ class CustomDomain(Domain):
106106

107107
def clear_doc(self, docname):
108108
if 'objects' in self.data:
109-
109+
110110
for key, (fn, _) in self.data['objects'].items():
111111
if fn == docname:
112112
del self.data['objects'][key]
@@ -153,8 +153,8 @@ def custom_domain(class_name, name='', label='', elements = {}):
153153
154154
- `role` - role name, defaults to entry's key
155155
156-
- `indextemplate` - e.g. ``pair: %s; Make Target``, where %s will be
157-
the matched part of your role. You may leave this empty, defaults
156+
- `indextemplate` - e.g. ``pair: %s; Make Target``, where %s will be
157+
the matched part of your role. You may leave this empty, defaults
158158
to ``pair: %s; <objname>``
159159
160160
- `parse_node` - a function with signature ``(env, sig, signode)``,

‎source/exts/font_awesome.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,13 @@ def support_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
8585

8686

8787
def setup(app): # pragma: no cover
88-
app.info('Adding the font awesome icon role')
88+
# app.info('Adding the font awesome icon role')
8989
app.add_role('icon', icon_role)
90-
app.info('Adding the font awesome github role')
90+
# app.info('Adding the font awesome github role')
9191
app.add_role('github', github_role)
92-
app.info('Adding the font awesome bitbucket role')
92+
# app.info('Adding the font awesome bitbucket role')
9393
app.add_role('bitbucket', bitbucket_role)
94-
app.info('Adding the font awesome nginx support link role')
94+
# app.info('Adding the font awesome nginx support link role')
9595
app.add_role('support', support_role)
9696

9797
return

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /