Skip to content

Commit e371f06

Browse files
committed
Update command name
1 parent 66795ea commit e371f06

4 files changed

Lines changed: 5 additions & 5 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
environments: pdoc
4141

4242
- name: Build Docs
43-
run: pixi run -e pdoc make-html # This errors on warnings
43+
run: pixi run -e pdoc python-doc # This errors on warnings
4444

4545
- name: deploy
4646
uses: peaceiris/actions-gh-pages@v4.0.0

docs/source/dev/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ To check your docstring additions/updates, you can build a local version of the
202202

203203
.. code-block:: shell
204204
205-
pixi r -e pdoc make-html
205+
pixi r -e pdoc python-doc
206206
207207
After running this command, simply open ``docs/_build/html/index.html`` using your favorite browser, e.g.:
208208

pixi.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ tests-p = "pytest --durations=20 tests/python"
131131
# it = "pytest --durations=20 tests/integration"
132132

133133
[tool.pixi.feature.python-doc.tasks]
134-
make-html = { cmd = "make html", cwd = "docs", env = { SPHINXOPTS = "--fail-on-warning --keep-going --nitpicky" }}
134+
python-doc = { cmd = "make html", cwd = "docs", env = { SPHINXOPTS = "--fail-on-warning --keep-going --nitpicky" }}
135135

136136
[tool.pixi.feature.python-build.tasks]
137137
build-wheels = { cmd = "uv build --sdist --wheel --out-dir dist/ ." }

0 commit comments

Comments
 (0)