Skip to content

Commit

Permalink
ci(workflows): add mkdocs build step to GitHub Actions workflow
Browse files Browse the repository at this point in the history
test(tox): add docs environment to tox for building documentation
  • Loading branch information
NodeJSmith committed Jun 13, 2024
1 parent 3f6957f commit cad2af2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/python_package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,6 @@ jobs:

- name: Run build checks
run: tox -e build

- name: Run mkdocs build
run: tox -e docs
13 changes: 13 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@ commands_pre =
commands =
poetry install --with dev
poetry run ruff check src

[testenv:docs]
allowlist_externals = poetry, ruff, mkdocs
extras =
dev
docs
deps =
poetry
commands_pre =
#
commands =
poetry install --with dev --with docs
poetry run mkdocs build

[testenv:build]
Expand All @@ -30,6 +42,7 @@ deps =
commands_pre =
#
commands =
poetry install --with dev
poetry build
poetry run twine check dist/*

Expand Down

0 comments on commit cad2af2

Please sign in to comment.