Skip to content

Commit 7c5025b

Browse files
mkumar73Copilot
andcommitted
fix(ci): replace split pip+poetry install with poetry --with docs in docs workflow, remove docformatter
Co-authored-by: Copilot <copilot@github.com>
1 parent 309e2e8 commit 7c5025b

4 files changed

Lines changed: 10 additions & 14 deletions

File tree

.github/workflows/docs.yml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,8 @@ jobs:
5151
path: .venv
5252
key: venv-docs-${{ runner.os }}-3.10-${{ hashFiles('poetry.lock') }}
5353

54-
- name: Install package
55-
run: poetry install --only main
56-
57-
- name: Install docs dependencies
58-
run: pip install -r docs/requirements_docs.txt
54+
- name: Install package and docs dependencies
55+
run: poetry install --with docs
5956

6057
- name: Build Sphinx docs
6158
run: poetry run sphinx-build -b html docs/ docs/_build/html -W --keep-going

docs/contributing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,11 @@ pip install -r docs/requirements_docs.txt
8282
```bash
8383
just check
8484
```
85+
If `ruff-format` modifies any files, commit those changes before pushing:
86+
```bash
87+
git add -u
88+
git commit -m "style: apply ruff formatting"
89+
```
8590
8. Commit your changes following the Conventional Commits specification (see below):
8691
```bash
8792
just commit

justfile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ lint:
2929

3030
# run docformatter and ruff formatter
3131
format:
32-
poetry run docformatter --in-place --recursive --wrap-summaries 120 --wrap-descriptions 120 .
3332
poetry run ruff format .
3433

3534
# run pyright type checking
@@ -42,9 +41,11 @@ test:
4241

4342
# build HTML docs locally (warnings treated as errors)
4443
docs:
45-
sphinx-build -b html docs/ docs/_build/html -W --keep-going
44+
poetry run sphinx-build -b html docs/ docs/_build/html -W --keep-going
4645

4746
# run all pre-commit hooks on all files (commit + push stage)
47+
# if ruff-format modifies files, stage and commit them before pushing:
48+
# git add -u && git commit -m "style: apply ruff formatting"
4849
check:
4950
poetry run pre-commit run --all-files
5051
poetry run pre-commit run --all-files --hook-stage push

pyproject.toml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,6 @@ ignore = [
132132
[tool.ruff.lint.pycodestyle]
133133
max-doc-length = 120
134134

135-
[tool.docformatter]
136-
recursive = true
137-
in-place = true
138-
wrap-summaries = 120
139-
wrap-descriptions = 120
140-
exclude = ["build", "dist", ".venv", ".git"]
141-
142135
# Commitizen configuration
143136
[tool.commitizen]
144137
name = "cz_conventional_commits"

0 commit comments

Comments
 (0)