Skip to content

Commit e7a2c9c

Browse files
authored
Various documentation enhancements (holoviz#1625)
1 parent 4deb1ae commit e7a2c9c

22 files changed

+908
-1407
lines changed

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
'examples_dir': '.',
113113
'galleries': {
114114
'reference': {
115-
'title': 'Reference Gallery',
115+
'title': 'Gallery',
116116
'intro': (
117117
'Find the list of supported libraries on `this page <../ref/data_libraries.html>`_.'
118118
),

doc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ align: center
434434
435435
Tutorials <tutorials/index>
436436
User Guide <user_guide/index>
437-
Reference Gallery <reference/index>
437+
Gallery <reference/index>
438438
Reference <ref/index>
439439
Developer Guide <developer_guide>
440440
Releases <releases>

doc/ref/api/index.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -192,30 +192,29 @@ The explorer interface can easily be created from the `hvPlot` / `.hvplot` names
192192
.. currentmodule:: hvplot
193193
194194
.. autosummary::
195-
:toctree: generated/
196195
197196
hvPlot.explorer
198197
```
199198

199+
```{toctree}
200+
:hidden: true
201+
:maxdepth: 2
202+
:titlesonly: true
203+
204+
hvplot.hvPlot.explorer <manual/hvplot.hvPlot.explorer>
205+
```
206+
200207
It is also available from the top-level `explorer` function:
201208

202209
```{eval-rst}
203210
.. currentmodule:: hvplot.ui
204211
205212
.. autosummary::
213+
:toctree: generated/
206214
207215
explorer
208216
```
209217

210-
211-
```{toctree}
212-
:hidden: true
213-
:maxdepth: 2
214-
:titlesonly: true
215-
216-
hvplot.hvPlot.explorer <manual/hvplot.hvPlot.explorer>
217-
```
218-
219218
Calling the `explorer` function/method returns an `hvPlotExplorer` object:
220219

221220
```{eval-rst}

doc/ref/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The reference section includes the API reference and pages that provide detailed
55
```{toctree}
66
:titlesonly:
77
:includehidden:
8-
:maxdepth: 2
8+
:maxdepth: 1
99
1010
Installation <installation>
1111
Supported data libraries <data_libraries>

doc/ref/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ uv pip install hvplot --prerelease allow
4646

4747
## From anaconda.org
4848

49-
hvPlot is distributed on 3 channels on [anaconda.org](https://anaconda.org/):
49+
hvPlot is distributed on 3 channels on [anaconda.org](https://anaconda.org):
5050

5151
- [`conda-forge`](https://github.com/conda-forge/hvplot-feedstock): Community maintained channel
5252
- [`defaults`](https://github.com/AnacondaRecipes/hvplot-feedstock/): Anaconda maintained channel (free under certain conditions only, check Anaconda's Terms of Services)

doc/ref/plotting_options/axis.ipynb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
"source": [
88
"# Axis Options\n",
99
"\n",
10+
"Customization options for axis appearance and behavior, including labels, limits, tick formatting, and axis scaling:\n",
11+
"\n",
1012
"```{eval-rst}\n",
1113
".. plotting-options-table:: Axis Options\n",
1214
"```"

0 commit comments

Comments
 (0)