Skip to content

Commit 2612e98

Browse files
committed
doc: rename ci files. make the doc ci trigger on tag or manual push.
Made dependency management better. clarified param x for hist api.
1 parent 6a6738c commit 2612e98

7 files changed

Lines changed: 93 additions & 8 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
- name: Install doc build requirements
4848
run: |
4949
uv venv .build-env
50-
uv pip install --python .build-env -r docs/requirements.txt
50+
uv sync
5151
- name: Build Sphinx Documentation
5252
run: |
5353
. .build-env/bin/activate
@@ -58,9 +58,11 @@ jobs:
5858
with:
5959
name: khisto-python-docs
6060
path: ./docs/_build/html/
61-
# Publish to GH pages on Git tag and manually
61+
# Publish to GH pages on Git tag push or manual dispatch
6262
publish:
63-
if: github.ref_type == 'tag' && github.event_name == 'workflow_dispatch' && inputs.deploy-gh-pages == true
63+
if: >-
64+
(github.ref_type == 'tag' && github.event_name == 'push') ||
65+
(github.event_name == 'workflow_dispatch' && inputs.deploy-gh-pages == true)
6466
needs: build
6567
runs-on: ubuntu-22.04
6668
permissions:

docs/api_comparison.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Key Differences
197197
- ``bins``, ``stacked``, and ``weights`` raise a ``TypeError``
198198
* - **Multiple datasets**
199199
- Supported
200-
- Sequences are concatenated into one dataset
200+
- Sequences are concatenated into one dataset. Sequences of different lengths are not supported.
201201

202202
Usage Comparison
203203
""""""""""""""""

pyproject.toml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ matplotlib = ["matplotlib>=3.8"]
1616
all = ["matplotlib>=3.8"]
1717

1818
[dependency-groups]
19-
dev = [
19+
test = [
2020
"pytest>=8.3",
2121
"pytest-xdist>=3.6",
2222
"pytest-cov>=6",
2323
"pytest-sugar>=1.0",
24+
]
25+
lint = [
2426
"pre-commit>=4.1",
2527
"pre-commit-hooks>=5.0",
2628
"ruff>=0.9",
27-
"ipykernel>=7",
28-
"matplotlib>=3.8",
2929
]
3030
docs = [
3131
"sphinx>=6.1",
@@ -37,6 +37,11 @@ docs = [
3737
"ipykernel>=7",
3838
"matplotlib>=3.8",
3939
]
40+
dev = [
41+
{include-group = "test"},
42+
{include-group = "lint"},
43+
{include-group = "docs"},
44+
]
4045

4146
[build-system]
4247
requires = ["scikit-build-core>=0.11.6", "ninja"]

sandbox/khisto_demo.ipynb

Lines changed: 77 additions & 0 deletions
Large diffs are not rendered by default.

src/khisto/matplotlib/hist.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,8 @@ def hist(
7474
----------
7575
x : array_like or sequence of array_like
7676
Input data. Nested arrays are concatenated and histogrammed as a
77-
single dataset.
77+
single dataset. This behavior is different from Matplotlib's hist, which treats a sequence of
78+
arrays as multiple datasets and plots them separately.
7879
range : tuple of (float, float), optional
7980
Lower and upper range of the bins. Values outside the range are
8081
ignored.

0 commit comments

Comments
 (0)