Skip to content

Commit

Permalink
Voilà with an accent
Browse files Browse the repository at this point in the history
  • Loading branch information
SylvainCorlay committed Aug 18, 2020
1 parent 4502f18 commit e852c4c
Show file tree
Hide file tree
Showing 66 changed files with 131 additions and 125 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
architecture: 'x64'
- name: Install JupyterLab
run: python -m pip install jupyterlab
- name: Install the Voila Preview JupyterLab extension
- name: Install the Voilà Preview JupyterLab extension
run: |
cd packages/jupyterlab-voila
jlpm && jlpm run build
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ cd voila/js
npm install
cd ..

# install voila in editable mode
# install Voilà in editable mode
python -m pip install -e .
```

Expand Down Expand Up @@ -161,5 +161,5 @@ python -m pytest

The default template files are located in the folder `share/jupyter/voila/templates/default`. They are automatically picked up when running Voilà in development mode.

Alternatively, there is a Voila template cookiecutter available to give you a running start. [Link](https://github.com/voila-dashboards/voila-template-cookiecutter).
Alternatively, there is a Voilà template cookiecutter available to give you a running start. [Link](https://github.com/voila-dashboards/voila-template-cookiecutter).
This cookiecutter contains some docker configuration for live reloading of your template changes to make development easier.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD License

Copyright (c) 2018 Voila contributors.
Copyright (c) 2018 Voilà contributors.
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,23 +86,23 @@ https://voila.readthedocs.io/
The following two examples show how a standalone Jupyter notebook can be turned into a separate app, from the command-line integration.

**Rendering a notebook including interactive widgets and rich mime-type rendering**
![Voila basics](voila-basics.gif)
![Voilà basics](voila-basics.gif)

**Rendering a notebook making use of a custom widget library ([bqplot](https://github.com/bloomberg/bqplot))**

![Voila bqplot](voila-bqplot.gif)
![Voilà bqplot](voila-bqplot.gif)

**Showing the source code for a Voilà notebook**

The sources of the Jupyter notebook can be displayed in a Voilà app if option `strip_sources` is set to `False`.

![Voila sources](voila-sources.gif)
![Voilà sources](voila-sources.gif)

**Voilà dashboards with other language kernels**

Voilà is built upon Jupyter standard formats and protocols, and is agnostic to the programming language of the notebook. In this example, we present an example of a Voilà application powered by the C++ Jupyter kernel [xeus-cling](https://github.com/jupyter-xeus/xeus-cling), and the [xleaflet](https://github.com/jupyter-xeus/xleaflet) project.

![Voila cling](voila-cling.gif)
![Voilà cling](voila-cling.gif)

## The Voilà Gallery

Expand Down
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
rst_prolog = """
.. note::
This documentation is for a development version of Voila. There may be
This documentation is for a development version of Voilà. There may be
significant differences from the latest stable release.
"""
Expand Down Expand Up @@ -38,8 +38,8 @@ def setup(app):
source_suffix = '.rst'
master_doc = 'index'
project = 'voila'
copyright = u'2020, The Voila Development Team'
author = u'The Voila Development Team'
copyright = u'2020, The Voilà Development Team'
author = u'The Voilà Development Team'
version = '.'.join(map(str, _release['version_info'][:2]))
release = _release['__version__']
language = None
Expand Down
4 changes: 2 additions & 2 deletions docs/source/contribute.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright (c) 2018, Voila Contributors
.. Copyright (c) 2018, Voilà Contributors
Copyright (c) 2018, QuantStack
Distributed under the terms of the BSD 3-Clause License.
Expand Down Expand Up @@ -42,7 +42,7 @@ First, you need to fork the project. Then setup your environment:
npm install
cd ..
# install Voila in editable mode
# install Voilà in editable mode
python -m pip install -e .
Run Voilà
Expand Down
10 changes: 5 additions & 5 deletions docs/source/customize.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright (c) 2018, Voila Contributors
.. Copyright (c) 2018, Voilà Contributors
Copyright (c) 2018, QuantStack
Distributed under the terms of the BSD 3-Clause License.
Expand Down Expand Up @@ -159,12 +159,12 @@ a Jupyter notebook by using the name of the folder in the ``--template`` paramet

The result should be a Voilà dashboard with your custom modifications made!

Voila template cookiecutter
Voilà template cookiecutter
-----------------------------
There is a Voila template cookiecutter available to give you a running start.
This cookiecutter contains some docker configuration for live reloading of your template changes to make development easier.
Please refer to the `cookiecutter repo <https://github.com/voila-dashboards/voila-template-cookiecutter>`_ for more information on how to use the Voila template cookiecutter.

There is a Voilà template cookiecutter available to give you a running start.
This cookiecutter contains some docker configuration for live reloading of your template changes to make development easier.
Please refer to the `cookiecutter repo <https://github.com/voila-dashboards/voila-template-cookiecutter>`_ for more information on how to use the Voilà template cookiecutter.

Adding your own static files
============================
Expand Down
20 changes: 10 additions & 10 deletions docs/source/deploy.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright (c) 2018, Voila Contributors
.. Copyright (c) 2018, Voilà Contributors
Copyright (c) 2018, QuantStack
Distributed under the terms of the BSD 3-Clause License.
Expand Down Expand Up @@ -104,7 +104,7 @@ automatically shutdown if it is idle.

The general steps for deployment at Heroku can be found
`here <https://devcenter.heroku.com/articles/getting-started-with-python>`__.
High level instructions, specific to voila can be found below:
High level instructions, specific to Voilà can be found below:

1. Follow the steps of the official documentation to install the heroku
cli and login on your machine.
Expand Down Expand Up @@ -202,7 +202,7 @@ High level instructions specific to Voilà can be found below:
gcloud app browse
Running voila on a private server
Running Voilà on a private server
=================================

Prerequisites
Expand Down Expand Up @@ -277,8 +277,8 @@ Steps
sudo python3 -m pip install -r requirements.txt
8. Create a new systemd service for running voila in ``/usr/lib/systemd/system/voila.service``.
The service will ensure voila is automatically restarted on startup:
8. Create a new systemd service for running Voilà in ``/usr/lib/systemd/system/voila.service``.
The service will ensure Voilà is automatically restarted on startup:

.. code:: text
Expand All @@ -297,8 +297,8 @@ The service will ensure voila is automatically restarted on startup:
[Install]
WantedBy=multi-user.target
In this example voila is started with ``voila --no-browser voila/notebooks/basics.ipynb`` to serve a single notebook.
You can edit the command to change this behavior and the notebooks voila is serving.
In this example Voilà is started with ``voila --no-browser voila/notebooks/basics.ipynb`` to serve a single notebook.
You can edit the command to change this behavior and the notebooks Voilà is serving.

9. Enable and start the ``voila`` service:

Expand All @@ -308,14 +308,14 @@ You can edit the command to change this behavior and the notebooks voila is serv
sudo systemctl start voila.service
.. note::
To check the logs for voila:
To check the logs for Voilà:

.. code:: text
journalctl -u voila.service
10. Now go to ``yourdomain.com`` to access the voila application.
10. Now go to ``yourdomain.com`` to access the Voilà application.

Enable HTTPS with Let's Encrypt
-------------------------------
Expand Down Expand Up @@ -348,7 +348,7 @@ Enable HTTPS with Let's Encrypt
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
...
4. Visit https://yourdomain.com to access the voila applications over HTTPS.
4. Visit https://yourdomain.com to access the Voilà applications over HTTPS.

5. To automatically renew the certificates (they expire after 90 days), open the ``crontab`` file:

Expand Down
5 changes: 1 addition & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright (c) 2018, Voila Contributors
.. Copyright (c) 2018, Voilà Contributors
Copyright (c) 2018, QuantStack
Distributed under the terms of the BSD 3-Clause License.
Expand All @@ -8,9 +8,6 @@
.. image:: voila-logo.svg
:alt: voila




*From notebooks to standalone web applications and dashboards.*

Voilà allows you to convert a Jupyter Notebook into an
Expand Down
4 changes: 2 additions & 2 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright (c) 2018, Voila Contributors
.. Copyright (c) 2018, Voilà Contributors
Copyright (c) 2018, QuantStack
Distributed under the terms of the BSD 3-Clause License.
Expand All @@ -11,7 +11,7 @@
Installing Voilà
================

Voila can be installed with the ``conda`` package manager
Voilà can be installed with the ``conda`` package manager

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/source/using.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright (c) 2018, Voila Contributors
.. Copyright (c) 2018, Voilà Contributors
Copyright (c) 2018, QuantStack
Distributed under the terms of the BSD 3-Clause License.
Expand Down
2 changes: 1 addition & 1 deletion js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@
"watch:lib": "babel src --out-dir lib --watch",
"watch:bundle": "webpack --watch --mode=development"
},
"author": "Voila contributors",
"author": "Voilà contributors",
"license": "BSD-3-Clause"
}
2 changes: 1 addition & 1 deletion js/src/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/***************************************************************************
* Copyright (c) 2018, Voila contributors *
* Copyright (c) 2018, Voilà contributors *
* Copyright (c) 2018, QuantStack *
* *
* Distributed under the terms of the BSD 3-Clause License. *
Expand Down
2 changes: 1 addition & 1 deletion js/src/kernel.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/***************************************************************************
* Copyright (c) 2018, Voila contributors *
* Copyright (c) 2018, Voilà contributors *
* Copyright (c) 2018, QuantStack *
* *
* Distributed under the terms of the BSD 3-Clause License. *
Expand Down
2 changes: 1 addition & 1 deletion js/src/loader.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/***************************************************************************
* Copyright (c) 2018, Voila contributors *
* Copyright (c) 2018, Voilà contributors *
* Copyright (c) 2018, QuantStack *
* *
* Distributed under the terms of the BSD 3-Clause License. *
Expand Down
2 changes: 1 addition & 1 deletion js/src/manager.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/***************************************************************************
* Copyright (c) 2018, Voila contributors *
* Copyright (c) 2018, Voilà contributors *
* Copyright (c) 2018, QuantStack *
* *
* Distributed under the terms of the BSD 3-Clause License. *
Expand Down
2 changes: 1 addition & 1 deletion notebooks/basics.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# So easy, *voilà*!\n",
"\n",
"In this example notebook, we demonstrate how voila can render Jupyter notebooks with interactions requiring a roundtrip to the kernel."
"In this example notebook, we demonstrate how Voilà can render Jupyter notebooks with interactions requiring a roundtrip to the kernel."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/bqplot.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# So easy, *voilà*!\n",
"\n",
"In this example notebook, we demonstrate how voila can render custom Jupyter widgets such as [bqplot](https://github.com/bloomberg/bqplot). "
"In this example notebook, we demonstrate how Voilà can render custom Jupyter widgets such as [bqplot](https://github.com/bloomberg/bqplot). "
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/dashboard.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"This demo uses voila to render a notebook to a custom HTML page using gridstack.js for the layout of each output. In the cell metadata you can change the default cell with and height (in grid units between 1 and 12) by specifying.\n",
"This demo uses Voilà to render a notebook to a custom HTML page using gridstack.js for the layout of each output. In the cell metadata you can change the default cell with and height (in grid units between 1 and 12) by specifying.\n",
" * `grid_row`\n",
" * `grid_columns`"
]
Expand Down
2 changes: 1 addition & 1 deletion notebooks/gridspecLayout.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# Which multiplication table do you want to learn?\n",
"\n",
"In this example notebook we demonstrate how voila can render different Jupyter widgets using [GridspecLayout](https://ipywidgets.readthedocs.io/en/latest/examples/Layout%20Templates.html#Grid-layout)"
"In this example notebook we demonstrate how Voilà can render different Jupyter widgets using [GridspecLayout](https://ipywidgets.readthedocs.io/en/latest/examples/Layout%20Templates.html#Grid-layout)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/interactive.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# So easy, *voilà*!\n",
"\n",
"In this example notebook, we demonstrate how voila can render notebooks making use of ipywidget's `@interact`."
"In this example notebook, we demonstrate how Voilà can render notebooks making use of ipywidget's `@interact`."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/ipympl.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# So easy, *voilà*!\n",
"\n",
"In this example notebook, we demonstrate how voila can render custom interactive matplotlib figures using the [ipympl](https://github.com/matplotlib/ipympl) widget."
"In this example notebook, we demonstrate how Voilà can render custom interactive matplotlib figures using the [ipympl](https://github.com/matplotlib/ipympl) widget."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/ipyvolume.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# So easy, *voilà*!\n",
"\n",
"In this example notebook, we demonstrate how voila can render custom Jupyter widgets such as [ipyvolume](https://github.com/maartenbreddels/ipyvolume). "
"In this example notebook, we demonstrate how Voilà can render custom Jupyter widgets such as [ipyvolume](https://github.com/maartenbreddels/ipyvolume). "
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/xleaflet.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Using voila with the C++ kernel and interactive widgets"
"## Using Voilà with the C++ kernel and interactive widgets"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion packages/jupyterlab-voila/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @jupyter-voila/jupyterlab-preview

A JupyterLab preview extension for Voila.
A JupyterLab preview extension for Voilà.

## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions packages/jupyterlab-voila/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jupyter-voila/jupyterlab-preview",
"version": "1.1.0",
"description": "A JupyterLab preview extension for Voila",
"description": "A JupyterLab preview extension for Voilà",
"keywords": [
"jupyter",
"jupyterlab",
Expand All @@ -12,7 +12,7 @@
"url": "https://github.com/voila-dashboards/voila/issues"
},
"license": "BSD-3-Clause",
"author": "Voila contributors",
"author": "Voilà contributors",
"files": [
"lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
"style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
Expand Down
8 changes: 4 additions & 4 deletions packages/jupyterlab-voila/schema/plugin.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"jupyter.lab.setting-icon-class": "jp-VoilaIcon",
"jupyter.lab.setting-icon-label": "Voila Preview",
"title": "Voila Preview",
"description": "Voila Preview Extension",
"jupyter.lab.setting-icon-label": "Voilà Preview",
"title": "Voilà Preview",
"description": "Voilà Preview Extension",
"properties": {
"renderOnSave": {
"title": "Render Preview on Save",
"description": "Render the voila preview automatically after saving the notebook",
"description": "Render the Voilà preview automatically after saving the notebook",
"default": false,
"type": "boolean"
}
Expand Down
Loading

0 comments on commit e852c4c

Please sign in to comment.