Skip to content

Commit a4abb10

Browse files
authored
Various small fixes to the docs (#1261)
1 parent 68e0b35 commit a4abb10

File tree

20 files changed

+80
-36
lines changed

20 files changed

+80
-36
lines changed

.github/workflows/docs.yaml

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -34,33 +34,19 @@ jobs:
3434
MOZ_HEADLESS: 1
3535
DISPLAY: ":99.0"
3636
steps:
37-
- uses: actions/checkout@v3
37+
- uses: holoviz-dev/holoviz_tasks/install@v0.1a19
3838
with:
39-
fetch-depth: "100"
40-
- uses: conda-incubator/setup-miniconda@v2
41-
with:
42-
mamba-version: "*"
43-
channels: pyviz/label/dev,conda-forge
44-
- name: Fetch unshallow
45-
run: git fetch --prune --tags --unshallow -f
39+
name: Documentation
40+
python-version: "3.11"
41+
channels: pyviz,conda-forge,nodefaults
42+
envs: "-o doc -o examples"
43+
cache: true
44+
conda-update: true
4645
- name: Set and echo git ref
4746
id: vars
4847
run: |
4948
echo "Deploying from ref ${GITHUB_REF#refs/*/}"
5049
echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
51-
- name: conda setup
52-
run: |
53-
conda config --remove channels defaults
54-
conda create -n test-environment python=3.8 pyctdev
55-
- name: doit develop_install
56-
run: |
57-
conda activate test-environment
58-
conda list
59-
doit develop_install -o doc -o examples --conda-mode=mamba
60-
- name: doit env_capture
61-
run: |
62-
conda activate test-environment
63-
doit env_capture
6450
- name: bokeh sampledata
6551
run: |
6652
conda activate test-environment

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ ENV/
107107
doc/**/*.rst
108108
doc/**/*.ipynb
109109
doc/**/*.json
110+
# thumbnails are downloaded on the fly
111+
doc/reference/*/thumbnails/
110112
# this dir contains the whole website and should not be checked in on main
111113
builtdocs/
112114
# mystnb

.pre-commit-config.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
default_stages: [commit]
55
repos:
66
- repo: https://github.com/nbQA-dev/nbQA
7-
rev: 1.6.3
7+
rev: 1.7.1
88
hooks:
99
- id: nbqa-flake8
1010
- repo: https://github.com/pre-commit/pre-commit-hooks
11-
rev: v4.3.0
11+
rev: v4.5.0
1212
hooks:
1313
- id: check-builtin-literals
1414
- id: check-case-conflict
@@ -20,13 +20,13 @@ repos:
2020
exclude: (\.min\.js$|\.svg$)
2121
- id: trailing-whitespace
2222
- repo: https://github.com/PyCQA/flake8
23-
rev: 4.0.1
23+
rev: 7.0.0
2424
hooks:
2525
- id: flake8 # See 'setup.cfg' for args
2626
args: [hvplot]
2727
files: hvplot/
2828
- repo: https://github.com/hoxbro/clean_notebook
29-
rev: v0.1.10
29+
rev: v0.1.14
3030
hooks:
3131
- id: clean-notebook
3232
- repo: https://github.com/codespell-project/codespell
File renamed without changes.
File renamed without changes.

doc/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
version = release = base_version(hvplot.__version__)
1616
nbbuild_cell_timeout = 600
1717

18+
exclude_patterns = ['governance']
19+
1820
html_static_path += ['_static']
1921

2022
html_css_files += [
@@ -75,6 +77,7 @@
7577
]
7678
}
7779
},
80+
'thumbnail_url': 'https://assets.holoviz.org/hvplot/thumbnails',
7881
}
7982

8083
nbsite_analytics = {

doc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ align: center
310310

311311
**`.interactive()` to turn data pipelines into widget-based interactive applications**
312312

313-
By starting a data pipeline with [`.interactive()`](getting_started/interactive.html) you can then inject widgets into an extract and transform data pipeline. The pipeline output dynamically updates with widget changes, making data exploration in Jupyter notebooks in particular a lot more efficient.
313+
By starting a data pipeline with [`.interactive()`](./getting_started/interactive) you can then inject widgets into an extract and transform data pipeline. The pipeline output dynamically updates with widget changes, making data exploration in Jupyter notebooks in particular a lot more efficient.
314314

315315
::::{tab-set}
316316

-1.17 MB
Binary file not shown.
-273 KB
Binary file not shown.
-185 KB
Binary file not shown.

0 commit comments

Comments
 (0)