docs: Add ruff commands to Makefile and pyproject (#1921)

This commit is contained in:
Eugene Yurtsev
2024-09-30 16:19:17 -04:00
committed by GitHub
parent cb8db211c2
commit d29747906d
3 changed files with 58 additions and 5 deletions
+11 -2
View File
@@ -1,4 +1,4 @@
.PHONY: build-docs serve-docs serve-clean-docs clean-docs codespell build-typedoc
.PHONY: lint-docs format-docs build-docs serve-docs serve-clean-docs clean-docs codespell build-typedoc
build-typedoc:
cd libs/sdk-js && yarn install --include-dev && yarn typedoc
@@ -19,6 +19,15 @@ clean-docs:
find ./docs/docs -name "*.ipynb" -type f -delete
rm -rf docs/site
## Run format against the project documentation.
format-docs:
poetry run ruff format docs/docs
poetry run ruff check --fix docs/docs
# Check the docs for linting violations
lint-docs:
poetry run ruff check docs/docs
codespell:
./docs/codespell_notebooks.sh .
@@ -26,4 +35,4 @@ start-services:
docker compose -f docs/test-compose.yml up -V --force-recreate --wait --remove-orphans
stop-services:
docker compose -f docs/test-compose.yml down
docker compose -f docs/test-compose.yml down