Skip to content

Commit b0cb8fb

Browse files
authored
Add sphinx-lint to the ci workflow and Makefile. (#496)
* Add sphinx-lint to the Makefile.
1 parent 2f6d0eb commit b0cb8fb

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

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
@@ -127,3 +129,7 @@ fuzzy: ## Find fuzzy strings
127129
.PHONY: rm_cpython
128130
rm_cpython: ## Remove cloned cpython repo
129131
rm -rf $(CPYTHON_CLONE)
132+
133+
.PHONY: lint
134+
lint: $(VENV)/bin/sphinx-lint ## Run sphinx-lint
135+
$(VENV)/bin/sphinx-lint --enable default-role

0 commit comments

Comments
 (0)