Skip to content

Commit afeecf7

Browse files
chore: fix docs issues
1 parent b297efc commit afeecf7

8 files changed

Lines changed: 39 additions & 37 deletions

File tree

docs/advanced_usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Advanced Usage
77
Slots are used to add content at a certain location in a widget. You can find out what slots a widget supports by using
88
the Vuetify documentation. If you want to know what slots :code:`Select` has, search for :code:`v-select` on the
99
`Vuetify API explorer <https://v2.vuetifyjs.com/components/api-explorer/>`_ or for this example use the `direct link
10-
<https://v2.vuetifyjs.com/en/components/selects/#api>`_. On the left-hand side of list of attributes you will find a tab
10+
<https://v2.vuetifyjs.com/en/components/selects/#api>`_. On the left-hand side of the list of attributes you will find a tab
1111
'slots'.
1212

1313
An example for using the slot 'no-data', which changes what the Select widget shows when it has no items:
@@ -101,7 +101,7 @@ exposes it as the 'on' variable.
101101
Responsive Layout
102102
-----------------
103103

104-
When making dashbords with Voilà you can change the layout depending on the users screen size. This is done with a `grid
104+
When making dashboards with Voilà you can change the layout depending on the user's screen size. This is done with a `grid
105105
system <https://v2.vuetifyjs.com/en/components/grids/>`_. For example on a laptop (breakpoint md) you could fit two
106106
elements next to each other while on a smartphone (defined with 'cols' as default) you would want one element to take up
107107
the full width:

docs/conf.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
# -- General configuration ---------------------------------------------------
1717

18-
extensions = ["jupyter_sphinx", "sphinx_rtd_theme", "sphinx_design"]
18+
extensions = ["jupyter_sphinx", "sphinx_design"]
1919
templates_path = ["_templates"]
2020
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
2121

@@ -24,6 +24,9 @@
2424
html_theme = "pydata_sphinx_theme"
2525
html_static_path = ["_static"]
2626
html_css_files = ["custom.css"]
27+
html_sidebars = {
28+
"**": [],
29+
}
2730

2831
# -- Theme configuration -----------------------------------------------------
2932

@@ -34,8 +37,6 @@
3437
"secondary_sidebar_items": [
3538
"page-toc.html",
3639
"searchbox.html",
37-
"edit-this-page.html",
38-
"sourcelink.html",
3940
],
4041
"icon_links": [
4142
{

docs/fruit-selector.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<v-btn @click="addBanana" :disabled="hasBanana">Add banana</v-btn>
66
<v-btn @click="removeBanana" :disabled="!hasBanana">Remove banana</v-btn>
77
<v-btn @click="add_fruit_python()" :disabled="!can_add_from_python"
8-
>Add from Pyton</v-btn
8+
>Add from Python</v-btn
99
>
1010
</div>
1111
Available fruits

docs/installation.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,16 @@ Using conda
1818
Jupyter Lab
1919
-----------
2020

21-
If you're using only the classic notebook, you're done. If you're using Jupyter Lab, the extension has to be installed
22-
in Jupyter Lab:
21+
If you're using the classic notebook or JupyterLab 3 and later, you're done after installing the Python package.
22+
The JupyterLab extension is included in the ``ipyvuetify`` package.
23+
24+
For JupyterLab 1 and 2, install the JupyterLab extension separately:
2325

2426
.. code-block:: bash
2527
2628
$ jupyter labextension install jupyter-vuetify
2729
2830
.. note::
29-
ipyvuetify depends on ipywidgets being installed in Jupyter Lab, see the `ipywidgets documentation
30-
<https://ipywidgets.readthedocs.io/en/stable/user_install.html#installing-the-jupyterlab-extension>`_ on how to do
31-
that.
31+
ipyvuetify depends on ipywidgets being available in JupyterLab. If widgets do not display, see the
32+
`ipywidgets installation documentation
33+
<https://ipywidgets.readthedocs.io/en/stable/user_install.html#installing-in-jupyterlab-3-x>`_.

docs/introduction.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Introduction
22
============
33

4-
Ipyvuetify is a widget library for making modern looking GUI's in Jupyter notebooks (classic and lab) and dashboards
4+
Ipyvuetify is a widget library for making modern-looking GUIs in Jupyter notebooks (classic and lab) and dashboards
55
(`Voilà <https://voila.readthedocs.io/en/stable/using.html>`_). It's based on the `Google material design philosophy
66
<https://material.io/design/introduction>`_ best known from the Android user interface.
77

8-
A large set of widgets is provided with many widgets having multiple variants. a few of which are displayed below.
8+
A large set of widgets is provided, with many widgets having multiple variants. A few of them are displayed below.
99

1010
.. TODO: fix CSS collisions with rtd_theme
1111
@@ -20,7 +20,7 @@ the standard widget library of Jupyter, ipyvuetify has a lot more widgets which
2020
composable at the expense of a bit more verbosity in the source code.
2121

2222
Ipyvuetify uses the machinery of `ipywidgets <https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20Basics.html>`_
23-
as a base, but has different conventions for the API. This is mainly due to the fact the Python API is generated from
23+
as a base, but has different conventions for the API. This is mainly because the Python API is generated from
2424
the JavaScript library it is based on: `Vuetify <https://v2.vuetifyjs.com/>`_. This exposes the full power of Vuetify and
2525
allows us to rely on the extensive documentation and examples of it. Generating code and relying on documentation from
2626
the underlying library allowed us to expose a lot of widgets to Jupyter in a relatively short amount of time.

docs/template_usage.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ First template
55
--------------
66

77
When building larger UI's it may be convenient to write composite widgets using
8-
the Vue template syntax. Lets start with a basic example:
8+
the Vue template syntax. Let's start with a basic example:
99

1010
.. jupyter-execute::
1111

@@ -87,7 +87,7 @@ Template in vue files
8787

8888
Although a powerful feature, programming Vue templates in a string is quite
8989
cumbersome, since you lose syntax highlighting and other advanced editor
90-
features. Instead, we can put out Vue template into a ``.vue`` file, and point
90+
features. Instead, we can put our Vue template into a ``.vue`` file, and point
9191
our VuetifyTemplate to it.
9292

9393

@@ -150,7 +150,7 @@ A demonstration in a screen capture:
150150

151151

152152
.. note::
153-
For this feature we require the watchdog packages. Install it using ``pip install "watchdog>=2.0"`` or ``conda install -c conda-forge "watchdog>=2.0"``
153+
For this feature we require the watchdog package. Install it using ``pip install "watchdog>=2.0"`` or ``conda install -c conda-forge "watchdog>=2.0"``
154154

155155
Embed ipywidgets
156156
----------------

docs/usage.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ Attributes can be changed at a later time by:
3030
'Banana')`, are not detected by ipywidgets.
3131

3232
What widgets are available and how they look can be found in the
33-
`Vuetify documentation <https://v2.vuetifyjs.com/components/selects/>`_. Browse the side bar on the left hand side and
34-
select a widget, then click <> on the right hand side on an example to see the source code for it. The HTML code may
33+
`Vuetify documentation <https://v2.vuetifyjs.com/components/selects/>`_. Browse the sidebar on the left-hand side and
34+
select a widget, then click <> on the right-hand side on an example to see the source code for it. The HTML code may
3535
seem unfamiliar at first, but this documentation will guide you through it. For starters to translate the Vuetify widget
3636
names, which are starting with :code:`v-`, to ipyvuetify, remove the :code:`v-` prefix and CamelCase the remaining
37-
name. E.g :code:`v-select` becomes :code:`Select` and :code:`v-list-item` becomes :code:`ListItem`.
37+
name. For example, :code:`v-select` becomes :code:`Select` and :code:`v-list-item` becomes :code:`ListItem`.
3838

3939
Equivalent Vuetify syntax of the example above:
4040

@@ -78,7 +78,7 @@ ipyvuetify:
7878

7979
v.Select(clearable=True, label='Fruits', items=['Apple', 'Pear', 'Cherry'], value='Apple')
8080

81-
Some attribute have naming conflicts with Python or ipywidgets. These are :code:`for`, :code:`open`, :code:`class` and
81+
Some attributes have naming conflicts with Python or ipywidgets. These are :code:`for`, :code:`open`, :code:`class` and
8282
:code:`style` and must be suffixed with an underscore. For example :code:`style` becomes :code:`style_`
8383

8484
Vuetify:
@@ -101,7 +101,7 @@ see an example of this. To look at how that variable is initialized you select t
101101
If it's an expression it's mostly used to set a List or a Dict, as is done with :code:`items` in the examples above.
102102
This can be the same in ipyvuetify.
103103

104-
for non-vuetify related attributes, the ones from the HTML tag, can be accessed through the :code:`attributes` trait.
104+
For non-vuetify related attributes, the ones from the HTML tag, can be accessed through the :code:`attributes` trait.
105105

106106
Vuetify:
107107

@@ -256,7 +256,7 @@ All `HTML events <https://www.w3schools.com/tags/ref_eventattributes.asp>`_ can
256256
omitted.
257257

258258
Widgets can have custom events, to find out which, the `Vuetify API explorer
259-
<https://v2.vuetifyjs.com/components/api-explorer/>`_ can be used. Search for a component and on the left-hand side of list
259+
<https://v2.vuetifyjs.com/components/api-explorer/>`_ can be used. Search for a component and on the left-hand side of the list
260260
of attributes you will find a tab for the events.
261261

262262
In Vuetify events are defined as attributes with an :code:`@` prefix. The equivalent Vuetify syntax of the example above
@@ -341,7 +341,7 @@ And colors:
341341
ClassList attribute
342342
^^^^^^^^^^^^^^^^^^^
343343

344-
The :code:`class` attribute of a Vuetify DOM elements give access to the built-in styles of the lib. See the `vuetify site <https://v2.vuetifyjs.com/en/styles/colors/>`__ to know more about available styling class. As mentioned in the previous section this can be set using the :code:`class_` member of the widget. In addition, ipyvuetify provides a :code:`class_list` member that works the same way as the `MDN classList property <https://developer.mozilla.org/en-US/docs/Web/API/Element/classList>`__. It embeds the following methods:
344+
The :code:`class` attribute of Vuetify DOM elements gives access to the built-in styles of the library. See the `Vuetify site <https://v2.vuetifyjs.com/en/styles/colors/>`__ to learn more about available styling classes. As mentioned in the previous section this can be set using the :code:`class_` member of the widget. In addition, ipyvuetify provides a :code:`class_list` member that works the same way as the `MDN classList property <https://developer.mozilla.org/en-US/docs/Web/API/Element/classList>`__. It embeds the following methods:
345345

346346
- :code:`add(*args)`: add class elements to the class\_ trait of the widget
347347

@@ -378,7 +378,7 @@ The :code:`class` attribute of a Vuetify DOM elements give access to the built-i
378378
Visibility
379379
^^^^^^^^^^
380380

381-
ipyvuetify widgets visibility can be changed using the built-in methods :code:`hide()` and :code:`show()`.
381+
ipyvuetify widget visibility can be changed using the built-in methods :code:`hide()` and :code:`show()`.
382382
Using :code:`hide` will add the :code:`d-none` class to the widget and :code:`show` will remove it, hiding and showing the widget to the end user without removing it from the notebook.
383383

384384
.. jupyter-execute::
@@ -505,11 +505,11 @@ translation from Vuetify examples to ipyvuetify.
505505

506506
- Component names convert to CamelCase and the v- prefix is stripped
507507

508-
+------------+------------------------+
509-
| Vuetify | ``<v-list-tile .../>`` |
510-
+------------+------------------------+
511-
| ipyvuetify | ``ListTitle(...)`` |
512-
+------------+------------------------+
508+
+------------+------------------------------+
509+
| Vuetify | ``<v-list-item-title .../>`` |
510+
+------------+------------------------------+
511+
| ipyvuetify | ``ListItemTitle(...)`` |
512+
+------------+------------------------------+
513513

514514
- Attributes
515515

@@ -523,11 +523,11 @@ translation from Vuetify examples to ipyvuetify.
523523

524524
- must have a value
525525

526-
+------------+------------------------+
527-
| Vuetify | ``<v-btn round ...`` |
528-
+------------+------------------------+
529-
| ipyvuetify | ``Btn(round=True ...`` |
530-
+------------+------------------------+
526+
+------------+--------------------------+
527+
| Vuetify | ``<v-btn rounded ...`` |
528+
+------------+--------------------------+
529+
| ipyvuetify | ``Btn(rounded=True ...`` |
530+
+------------+--------------------------+
531531

532532
- with naming conflicts, ``style``, ``class``, ``open`` and ``for``, are suffixed with an ``_``
533533

@@ -565,7 +565,7 @@ translation from Vuetify examples to ipyvuetify.
565565
| | ``button.on_event('click', some_method)`` |
566566
+------------+--------------------------------------------+
567567

568-
- Regular HTML tags can made with the Html widget
568+
- Regular HTML tags can be made with the Html widget
569569

570570
+------------+-------------------------------------+
571571
| Vuetify | ``<div>...</div>`` |

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ doc = [
5555
"ipykernel",
5656
"pydata-sphinx-theme",
5757
"sphinx-design",
58-
"sphinx_rtd_theme",
5958
]
6059

6160
[tool.setuptools]

0 commit comments

Comments
 (0)