Skip to content

Commit 19e8def

Browse files
committed
Add sphinx-lint to the ci workflow and Makefile.
1 parent 6ab9311 commit 19e8def

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

.github/workflows/ci.yml

+3
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,6 @@ jobs:
1414

1515
- name: Validate
1616
run: VERSION=${{ github.event.pull_request.base.ref }} MODE=dummy make all
17+
18+
- name: Lint
19+
run: make lint

Makefile

+7-1
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,16 @@ $(VENV)/bin/activate:
6969
$(VENV)/bin/sphinx-build: $(VENV)/bin/activate
7070
. $(VENV)/bin/activate; python3 -m pip install sphinx python-docs-theme
7171

72+
$(VENV)/bin/sphinx-lint: $(VENV)/bin/activate
73+
. $(VENV)/bin/activate; python3 -m pip install sphinx-lint
7274

7375
$(VENV)/bin/blurb: $(VENV)/bin/activate
7476
. $(VENV)/bin/activate; python3 -m pip install blurb
7577

7678

7779
.PHONY: upgrade_venv
7880
upgrade_venv: $(VENV)/bin/activate ## Upgrade the venv that compiles the doc
79-
. $(VENV)/bin/activate; python3 -m pip install --upgrade sphinx python-docs-theme blurb
81+
. $(VENV)/bin/activate; python3 -m pip install --upgrade sphinx python-docs-theme blurb sphinx-lint
8082

8183

8284
.PHONY: progress
@@ -130,3 +132,7 @@ fuzzy: ## Find fuzzy strings
130132
.PHONY: rm_cpython
131133
rm_cpython: ## Remove cloned cpython repo
132134
rm -rf $(CPYTHON_CLONE)
135+
136+
.PHONY: lint
137+
lint: $(VENV)/bin/sphinx-lint ## Run sphinx-lint
138+
$(VENV)/bin/sphinx-lint .

0 commit comments

Comments
 (0)