Skip to content

Commit

Permalink
✏️ Fix external links
Browse files Browse the repository at this point in the history
  • Loading branch information
veit committed Jul 14, 2023
1 parent 4924e5a commit cf8b399
Show file tree
Hide file tree
Showing 34 changed files with 98 additions and 95 deletions.
2 changes: 1 addition & 1 deletion docs/binder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Binder provides a full open-source infrastructure stack. The main tools are
creates reproducible Docker images from a Git repository.

.. seealso::
* `Repository <https://github.com/jupyter/repo2docker>`__
* `Repository <https://github.com/jupyterhub/repo2docker>`__
* `Docs <https://repo2docker.readthedocs.io/en/latest/>`__

`mybinder.org <https://mybinder.org/>`_
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Dashboards
It's great for viewing static reports, but it can also be used in
conjunction with :doc:`interaktiven Widgets </ipywidgets/embedding>`.
:doc:`panel/index`
was developed on the basis of `Bokeh <https://docs.bokeh.org/>`_
was developed on the basis of `Bokeh <https://docs.bokeh.org/en/latest/>`_
and `Param <https://github.com/holoviz/param>`_ and offers a toolkit
especially for creating apps and dashboards, which not only supports bokeh
plots, see also `Panel: A high-level app and dashboarding solution for the
Expand Down
13 changes: 7 additions & 6 deletions docs/dashboards/jupyter-dashboards/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ Jupyter Dashboards
==================

The `Jupyter Dashboards Layout Extension
<https://jupyter-dashboards-layout.readthedocs.io/>`_ is an add-on for Jupyter
notebooks, with which outputs (text, plots, widgets, etc.) can be arranged in a
design grid or in report form. It saves the information on the layout directly
in the notebook so that other users of this extension can also see the notebook
in the same layout. For examples of dashboards, see `Jupyter Dashboards Demos
<https://github.com/jupyter/dashboards/tree/master/etc/notebooks>`_.
<https://jupyter-dashboards-layout.readthedocs.io/en/latest/>`_ is an add-on for
Jupyter notebooks, with which outputs (text, plots, widgets, :abbr:`etc. (et
cetera)`) can be arranged in a design grid or in report form. It saves the
information on the layout directly in the notebook so that other users of this
extension can also see the notebook in the same layout. For examples of
dashboards, see `Jupyter Dashboards Demos
<https://github.com/jupyter-attic/dashboards/tree/master/etc/notebooks>`_.

Use case
--------
Expand Down
6 changes: 3 additions & 3 deletions docs/dashboards/jupyter-flex/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Jupyter extension that turns notebooks into dashboards:
* :doc:`/ipywidgets/index` support

.. seealso::
* `Docs <https://jupyter-flex.extrapolations.dev/>`_
* `Docs <https://jupyter-flex.danielfrg.com>`_
* `GitHub <https://github.com/danielfrg/jupyter-flex>`_

Examples
Expand All @@ -24,11 +24,11 @@ Examples

.. figure:: data-scoring.png
:alt: NBA scoring
:target: https://jupyter-flex.extrapolations.dev/examples/nba-scoring.html
:target: https://jupyter-flex.danielfrg.com/examples/nba-scoring.html

.. figure:: altair.png
:alt: Altair plots
:target: https://jupyter-flex.extrapolations.dev/examples/altair.html
:target: https://jupyter-flex.danielfrg.com/examples/altair.html

Installation
------------
Expand Down
8 changes: 4 additions & 4 deletions docs/dashboards/panel/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ Panel
=====

`Panel <https://panel.holoviz.org/>`_ was developed on the basis of `Bokeh
<https://bokeh.pydata.org/en/latest/>`_ and `Param
<https://github.com/pyviz/param>`_ and offers a toolkit especially for creating
apps and dashboards, which not only supports bokeh plots.
<https://docs.bokeh.org/en/latest/>`_ and `Param
<https://github.com/holoviz/param>`_ and offers a toolkit especially for
creating apps and dashboards, which not only supports bokeh plots.

.. seealso::
* `Panel Announcement <http://blog.pyviz.org/panel_announcement.html>`_
* `Panel Announcement <https://blog.holoviz.org/panel_announcement.html>`_
* `Panel: A high-level app and dashboarding solution for the PyData ecosystem
<https://medium.com/@philipp.jfr/panel-announcement-2107c2b15f52>`_.

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards/panel/overview.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1414,7 +1414,7 @@
"\n",
"The above approaches each work with a variety of displayable objects, including images, equations, tables, and charts. In each case, the panel provides interactive functionality using widgets and updates the objects displayed accordingly, making very few assumptions about what is actually displayed. Panel also supports a broader and more dynamic interactivity in which the displayed object itself is interactive, e.g. JavaScript-based diagrams of Bokeh and Plotly.\n",
"\n",
"For example, if we replace the matplotlib wrapper that came with pandas with the [Bokeh](https://docs.bokeh.org/) wrapper [hvPlot](https://hvplot.holoviz.org/), we automatically get interactive plots that allow *zooming*, *panning* and *hovering*:"
"For example, if we replace the matplotlib wrapper that came with pandas with the [Bokeh](https://docs.bokeh.org/en/latest/) wrapper [hvPlot](https://hvplot.holoviz.org/), we automatically get interactive plots that allow *zooming*, *panning* and *hovering*:"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/dashboards/panel/params.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# Parameterisation\n",
"\n",
"Panel supports the use of parameters and dependencies between parameters, expressed in a simple way by [param](https://github.com/ioam/param), to encapsulate dashboards as declarative, stand-alone classes.\n",
"Panel supports the use of parameters and dependencies between parameters, expressed in a simple way by [param](https://github.com/holoviz/param), to encapsulate dashboards as declarative, stand-alone classes.\n",
"\n",
"Parameters are Python attributes that have been extended using the `param` library to support types, ranges, and documentation. This is just the information you need to automatically create widgets for each parameter."
]
Expand Down Expand Up @@ -1413,7 +1413,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The parameterised and annotated `view` method can return any type provided by the [Pane-Objects](https://panel.holoviz.org/user_guide/Components.html#panes) panel. This makes it easy to link parameters and their associated widgets to a plot or other output. Parameterised classes can therefore be a very useful pattern for encapsulating part of a computational workflow with an associated visualisation and for declaratively expressing the dependencies between the parameters and the computation.\n",
"The parameterised and annotated `view` method can return any type provided by the [Pane objects](https://panel.holoviz.org/explanation/components/components_overview.html#panes). This makes it easy to link parameters and their associated widgets to a plot or other output. Parameterised classes can therefore be a very useful pattern for encapsulating part of a computational workflow with an associated visualisation and for declaratively expressing the dependencies between the parameters and the computation.\n",
"\n",
"By default, a Param area (*Pane*) shows widgets for all parameters with a `precedence` value above the value `pn.Param.display_threshold`, so you can use `precedence` to automatically hide parameters. You can also explicitly choose which parameters should contain widgets in a certain area by passing an `parameters` argument. For example, this code outputs a `phase` widget, keeping `sine.frequency` the initial value `1`:"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards/panel/templates.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"\n",
"If you want to provide a panel app or a dashboard as a bokeh application, it is rendered in a standard template that refers to the JS and CSS resources as well as the actual panel object. If you want to adapt the layout of the provided app or if you want to provide several separate panels in one app, the `Template` component of Panel allows you to adapt this standard template.\n",
"\n",
"Such a template is defined with [Jinja](https://jinja.palletsprojects.com/), whereby you can extend or even completely replace the standard template. Here is an example:\n",
"Such a template is defined with [Jinja](https://jinja.palletsprojects.com/en/3.1.x/), whereby you can extend or even completely replace the standard template. Here is an example:\n",
"\n",
"```html\n",
" <!DOCTYPE html>\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards/panel/widgets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,7 @@
"source": [
"## Widgets\n",
"\n",
"To put several widgets together, they can be added to a `Row`-, `Column`- or `Tabs` panel. For more information on the layout of widgets and control panels, see the [customization user guide](https://panel.holoviz.org/user_guide/Customization.html)."
"To put several widgets together, they can be added to a `Row`-, `Column`- or `Tabs` panel. For more information on the layout of widgets and control panels, see [Declare Custom Widgets](https://panel.holoviz.org/how_to/param/custom.html)."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards/voila/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Voilà
=====

`Voilà <https://github.com/voila-dashboards/voila>`_ was developed by
`QuantStack <http://quantstack.net/>`_.
`QuantStack <https://quantstack.net>`_.

Features
--------
Expand Down
12 changes: 6 additions & 6 deletions docs/dashboards/voila/templating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ the outdated :doc:`../jupyter-dashboards/index`.
voila-vuetify
-------------

`voila-vuetify <https://github.com/QuantStack/voila-vuetify>`_ is a template for
using Voilà with the `Material Design Component Framework
<https://material.io/>`_ `Vuetify.js <https://vuetifyjs.com/>`_.
`voila-vuetify <https://github.com/voila-dashboards/voila-vuetify>`_ is a
template for using Voilà with the `Material Design Component Framework
<https://m3.material.io>`_ `Vuetify.js <https://vuetifyjs.com/>`_.

Installation
~~~~~~~~~~~~

.. code-block:: console
$ pipenv install bqplot ipyvuetify voila-vuetify==voila-vuetify 0.0.1a8
$ pipenv install bqplot ipyvuetify voila-vuetify
Usage
~~~~~
Expand Down Expand Up @@ -89,8 +89,8 @@ Example for Voilà-vuetify with the monitor resolution of an iPhone X:
voila-debug
-----------

`voila-debug <https://github.com/QuantStack/voila-debug>`_ is a template for
displaying debug information when working on Voilà applications.
`voila-debug <https://github.com/voila-dashboards/voila-debug>`_ is a template
for displaying debug information when working on Voilà applications.

Installation
~~~~~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions docs/hub/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
JupyterHub
==========

`JupyterHub <https://jupyterhub.readthedocs.io/>`_ is a multi-user server for
Jupyter Notebooks, which can create and manage many different instances of
Jupyter Notebooks and which acts as a proxy.
`JupyterHub <https://jupyterhub.readthedocs.io/en/stable/>`_ is a multi-user
server for Jupyter Notebooks, which can create and manage many different
instances of Jupyter Notebooks and which acts as a proxy.

.. toctree::
:hidden:
Expand Down
2 changes: 1 addition & 1 deletion docs/hub/ipyparallel/asyncresult.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
"\n",
"**See also:**\n",
"\n",
"If you want to expand the results of `AsyncResult` or `AsyncMapResult` you can do so with the `msg_ids` attribute. You can find an example for this at [ipyparallel/examples/customresults.py](https://github.com/ipython/ipyparallel/blob/master/examples/customresults.py).\n",
"If you want to expand the results of `AsyncResult` or `AsyncMapResult` you can do so with the `msg_ids` attribute. You can find an example for this at [ipyparallel/docs/source/examples/customresults.py](https://github.com/ipython/ipyparallel/blob/main/docs/source/examples/customresults.py).\n",
"</div>"
]
}
Expand Down
18 changes: 9 additions & 9 deletions docs/hub/ipyparallel/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ when the IPython hub is started, usually in
#. If we don’t want to use the ``default`` profile, we should first create a new
IPython profile with:

.. code-block:: console
.. code-block:: console
$ pipenv run ipython profile create --parallel --profile=local
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipython_config.py'
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipython_kernel_config.py'
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipcontroller_config.py'
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipengine_config.py'
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipcluster_config.py
$ pipenv run ipython profile create --parallel --profile=local
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipython_config.py'
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipython_kernel_config.py'
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipcontroller_config.py'
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipengine_config.py'
[ProfileCreate] Generating default config file: '/Users/veit/.ipython/profile_parallel/ipcluster_config.py
``--parallel``
``--parallel``
includes the configuration files for *Parallel Computing* (``ipengine``, ``ipcontroller`` etc.).

#. When the IPython controller and the engines are started, the files
Expand All @@ -27,7 +27,7 @@ when the IPython hub is started, usually in
``ipcluster`` in ``mpiexec``/``mpirun`` mode
--------------------------------------------

#. Creating the profile::
#. Creating the profile:

.. code-block:: console
Expand Down
4 changes: 2 additions & 2 deletions docs/hub/ipyparallel/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
===============

This section provides an overview of `ipyparallel
<https://ipyparallel.readthedocs.io/>`_ which supports different types of
parallelisation, including:
<https://ipyparallel.readthedocs.io/en/latest/>`_ which supports different types
of parallelisation, including:

- Single Program, Multiple Data (SPMD)
- Multiple program, multiple data (MPMD)
Expand Down
8 changes: 4 additions & 4 deletions docs/hub/ipyparallel/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,10 @@ Start
Batch systems
Besides the possibility to start ``ipcontroller`` and ``ipengine`` locally,
see *Starting the controller and engine on your local machine* in
:ref:`ipyparallel:/tutorial/process.md#starting-a-cluster-with-ssh`, there
are also the profiles for ``MPI``, ``PBS``, ``SGE``, ``LSF``, ``HTCondor``,
``Slurm``, ``SSH`` and ``WindowsHPC``.
see `Starting a cluster with SSH
<https://ipyparallel.readthedocs.io/en/latest/tutorial/process.html#starting-a-cluster-with-ssh>`_,
there are also the profiles for ``MPI``, ``PBS``, ``SGE``, ``LSF``,
``HTCondor``, ``Slurm``, ``SSH`` and ``WindowsHPC``.

This can be configured in ``ipcluster_config.py`` for example with
``c.IPClusterEngines.engine_launcher_class = 'SSH'`` or with
Expand Down
6 changes: 3 additions & 3 deletions docs/hub/ipyparallel/mpi.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@
" $ sudo apt install mpich\n",
" ```\n",
"\n",
" Alternatively, OpenMPI or MPICH can also be installed with [Spack](https://python4datascience.readthedocs.io/en/latest/productive/envs/spack/use.html): the packages are `openmpi` or `mpich`. \n",
" Alternatively, OpenMPI or MPICH can also be installed with [Spack](https://www.python4data.science/en/latest/productive/envs/spack/use.html): the packages are `openmpi` or `mpich`. \n",
"\n",
"\n",
"* [mpi4py](https://mpi4py.readthedocs.io/)"
"* [mpi4py](https://mpi4py.readthedocs.io/en/stable/)"
]
},
{
Expand All @@ -55,7 +55,7 @@
"\n",
"### Automatic start with PBS and `ipcluster`\n",
"\n",
"The `ipcluster` command also offers integration in [PBS](https://www.openpbs.org/). You can find more information about this in [Using ipcluster in PBS mode](https://ipyparallel.readthedocs.io/en/latest/tutorial/process.html#using-ipcluster-in-pbs-mode)."
"The `ipcluster` command also offers integration in [PBS](https://www.openpbs.org/). You can find more information about this in [Starting IPython Parallel on a traditional cluster](https://ipyparallel.readthedocs.io/en/latest/tutorial/process.html#starting-ipython-parallel-on-a-traditional-cluster)."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/hub/systemdspawner.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ system with
To limit memory and CPU allocations, certain kernel options must also be
available. This can be checked with `check-kernel.bash
<https://github.com/jupyterhub/systemdspawner/blob/master/check-kernel.bash>`_.
<https://github.com/jupyterhub/systemdspawner/blob/main/check-kernel.bash>`_.

If the default setting :samp:`c.SystemdSpawner.dynamic_users = False` is used,
the server is started with the local Unix user account. Therefore, this spawner
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
Jupyter Tutorial
================

`Jupyter notebooks <https://jupyter-notebook.readthedocs.io/>`_ are growing in
popularity with data scientists and have become the de facto standard for
rapid prototyping and exploratory analysis. They inspire experiments and
`Jupyter notebooks <https://jupyter-notebook.readthedocs.io/en/stable/>`_ are
growing in popularity with data scientists and have become the de facto standard
for rapid prototyping and exploratory analysis. They inspire experiments and
innovations enormously and as well they make the entire research process faster
and more reliable. In addition, many additional components are created that
expand the original limits of their use and enable new uses.
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ and data analysis. In 2017, Jupyter received the `ACM Software Systems Award
To understand why Jupyter notebooks are so successful, let’s take a closer look
at the core functions:

`Jupyter Notebook Format <https://nbformat.readthedocs.io/>`_
`Jupyter Notebook Format <https://nbformat.readthedocs.io/en/latest/>`_
Jupyter Notebooks are an open, JSON-based document format with full records
of the user’s sessions and the code they contain.
Interactive Computing Protocol
Expand Down
2 changes: 1 addition & 1 deletion docs/ipywidgets/custom-widget.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@
"source": [
"## Create Jupyter widgets from a template\n",
"\n",
"A [Cookiecutter](https://github.com/cookiecutter/cookiecutter) is available with [widget-cookiecutter](https://github.com/jupyter/widget-cookiecutter). It contains an implementation for a placeholder widget *Hello World*. It also makes it easier for you to pack and distribute your Jupyter widgets."
"A [Cookiecutter](https://github.com/cookiecutter/cookiecutter) is available with [widget-cookiecutter](https://github.com/jupyter-widgets/widget-cookiecutter). It contains an implementation for a placeholder widget *Hello World*. It also makes it easier for you to pack and distribute your Jupyter widgets."
]
}
],
Expand Down
6 changes: 3 additions & 3 deletions docs/ipywidgets/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
``ipywidgets``
==============

`ipywidgets <https://ipywidgets.readthedocs.io/>`_ are interactive widgets for
Jupyter notebooks. They extend notebooks by the possibility that users can enter
data themselves, manipulate data and see the changed results.
`ipywidgets <https://ipywidgets.readthedocs.io/en/stable/>`_ are interactive
widgets for Jupyter notebooks. They extend notebooks by the possibility that
users can enter data themselves, manipulate data and see the changed results.

.. toctree::
:hidden:
Expand Down
2 changes: 1 addition & 1 deletion docs/ipywidgets/libs/ipympl.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# `ipympl`\n",
"\n",
"Since the Jupyter widget ecosystem is developing too quickly, the Matplotlib developers have decided to outsource the support to a separate module: `ipympl` or [jupyter-matplotlib](https://github.com/matplotlib/jupyter-matplotlib)."
"Since the Jupyter widget ecosystem is developing too quickly, the Matplotlib developers have decided to outsource the support to a separate module: `ipympl` or [jupyter-matplotlib](https://github.com/matplotlib/ipympl)."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/ipywidgets/libs/ipyvuetify.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# `ipyvuetify`\n",
"\n",
"[ipyvuetify](https://github.com/mariobuikhuizen/ipyvuetify) provides Jupyter widgets based on [vuetify](https://v15.vuetifyjs.com/en/) UI components and implementing Google’s [Material Design](https://material.io/) with the [Vue.js-Framework](https://vuejs.org/) framework."
"[ipyvuetify](https://github.com/widgetti/ipyvuetify) provides Jupyter widgets based on [vuetify](https://v15.vuetifyjs.com/en/) UI components and implementing Google’s [Material Design](https://m3.material.io) with the [Vue.js-Framework](https://vuejs.org/) framework."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/ipywidgets/widget-events.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
"\n",
"Widget properties are IPython traitlets. To make changes, the `observe` method of the widget can be used to register a callback. You can see the docstring for observe below.\n",
"\n",
"You can find more information at [Traitlet events](https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20Events.html#Traitlet-events)."
"You can find more information at [Traitlet events](https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20Events.html#traitlet-events)."
]
},
{
Expand Down

0 comments on commit cf8b399

Please sign in to comment.