Skip to content

Commit

Permalink
v1.13 doc fixes (#4295)
Browse files Browse the repository at this point in the history
  • Loading branch information
philippjfr committed Mar 20, 2020
1 parent 69e931a commit 7e23dff
Show file tree
Hide file tree
Showing 55 changed files with 567 additions and 478 deletions.
9 changes: 4 additions & 5 deletions doc/about.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
About Us
========

HoloViews is supported and maintained by `Anaconda <https://www.anaconda.com>`_.
HoloViews is an `open-source <https://github.com/holoviz/holoviews/blob/master/LICENSE.txt>`_ Python library designed to make data analysis and visualization seamless and simple. With HoloViews, you can usually express what you want to do in very few lines of code, letting you focus on what you are trying to explore and convey, not on the process of plotting.

If you have any questions or usage issues visit the `HoloViews Discourse <https://discourse.holoviz.org/c/holoviews/>`_ site. If you are interested in contributing to HoloViews development to help address some of the `open issues <https://github.com/holoviz/holoviews/issues>`_.

The primary developers are Jean-Luc Stevens, Philipp Rudiger, and
James A. Bednar, with bug reports and patches from numerous members of
the Github community.
HoloViews is supported and maintained by `Anaconda <https://www.anaconda.com>`_.

Prior Funding
-------------
Expand All @@ -22,4 +22,3 @@ Doctoral Training Centre in Neuroinformatics and Computational Neuroscience <htt
from the UK Engineering and Physical Sciences Research Council,
Biotechnology and Biological Sciences Research Council, and
Medical Research Council.

1 change: 0 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@
# Social links
'SOCIAL': (
('Discourse', '//discourse.holoviz.org/c/holoviews'),
('Gitter', '//gitter.im/pyviz/pyviz'),
('Twitter', '//twitter.com/holoviews'),
('Github', '//github.com/pyviz/holoviews'),
),
Expand Down
20 changes: 6 additions & 14 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div style="display: flex">
<div style="width: 70%">

HoloViews is an `open-source <https://github.com/pyviz/holoviews/blob/master/LICENSE.txt>`_ Python library designed to make data analysis and visualization seamless and simple. With HoloViews, you can usually express what you want to do in very few lines of code, letting you focus on what you are trying to explore and convey, not on the process of plotting.
HoloViews is an `open-source <https://github.com/holoviz/holoviews/blob/master/LICENSE.txt>`_ Python library designed to make data analysis and visualization seamless and simple. With HoloViews, you can usually express what you want to do in very few lines of code, letting you focus on what you are trying to explore and convey, not on the process of plotting.

For examples, check out the thumbnails below and the other items in the `Gallery <gallery>`_ of demos and apps and the `Reference Gallery <reference>`_ that shows every HoloViews component. Be sure to look at the code, not just the pictures, to appreciate how easy it is to create such plots yourself!

Expand All @@ -21,7 +21,7 @@ The `User Guide <user_guide>`_ goes more deeply into key concepts from HoloViews

The `API <Reference_Manual>`_ is the definitive guide to each HoloViews object, but the same information is available more conveniently via the `hv.help()` command and tab completion in the Jupyter notebook.

If you have any `issues <https://github.com/pyviz/holoviews/issues>`_ or wish to `contribute code <https://help.github.com/articles/about-pull-requests>`_, you can visit our `GitHub site <https://github.com/pyviz/holoviews>`_ or chat with the developers on `gitter <https://gitter.im/pyviz/pyviz>`_.
If you have any `issues <https://github.com/holoviz/holoviews/issues>`_ or wish to `contribute code <https://help.github.com/articles/about-pull-requests>`_, you can visit our `GitHub site <https://github.com/holoviz/holoviews>`_ or file a topic on the `HoloViz Discourse <https://discourse.holoviz.org/>`_.

.. raw:: html

Expand Down Expand Up @@ -74,27 +74,20 @@ ____________
|CondaPkg|_ |PyPI|_ |License|_ |Coveralls|_


HoloViews works with `Python 2.7 and Python 3 <https://travis-ci.org/pyviz/holoviews>`_ on Linux, Windows, or Mac, and provides optional extensions for working with the `Jupyter/IPython Notebook <http://jupyter.org>`_.
HoloViews works with `Python 2.7 and Python 3 <https://travis-ci.org/holoviz/holoviews>`_ on Linux, Windows, or Mac, and provides optional extensions for working with the `Jupyter/IPython Notebook <http://jupyter.org>`_.

The recommended way to install HoloViews is using the `conda <http://conda.pydata.org/docs/>`_ command provided by `Anaconda <http://docs.continuum.io/anaconda/install>`_ or `Miniconda <http://conda.pydata.org/miniconda.html>`_::

conda install -c pyviz holoviews bokeh

This command will install the typical packages most useful with HoloViews, though HoloViews itself
directly depends only on `Numpy <http://numpy.org>`_ and `Param <http://param.pyviz.org/>`_.
directly depends only on `Numpy <http://numpy.org>`_ and `Param <http://param.holoviz.org/>`_.
Additional installation and configuration options are described in the
`user guide <user_guide/Installing_and_Configuring.html>`_.

Additional methods of installation, including different ways to use
``pip`` can be found in the `installation guide <install.html>`_.

PyViz
-----

HoloViews is part of the PyViz family of tools. The `PyViz website <http://pyviz.org>`_
shows how to use HoloViews together with other libraries to solve complex problems,
including detailed tutorials and examples.

Usage
-----

Expand Down Expand Up @@ -129,7 +122,7 @@ After you have successfully installed and configured HoloViews, please see `Gett
.. _CondaPkg: https://anaconda.org/pyviz/holoviews

.. |License| image:: https://img.shields.io/pypi/l/holoviews.svg
.. _License: https://github.com/pyviz/holoviews/blob/master/LICENSE.txt
.. _License: https://github.com/holoviz/holoviews/blob/master/LICENSE.txt

.. |Coveralls| image:: https://img.shields.io/coveralls/pyviz/holoviews.svg
.. _Coveralls: https://coveralls.io/r/pyviz/holoviews
Expand All @@ -143,10 +136,9 @@ After you have successfully installed and configured HoloViews, please see `Gett
Getting Started <getting_started/index>
User Guide <user_guide/index>
Reference Gallery <reference/index>
Showcase <showcase/index>
Releases <releases>
API <Reference_Manual/index>
FAQ
Roadmap <Roadmap>
Github source <http://github.com/pyviz/holoviews>
Github source <https://github.com/holoviz/holoviews>
About <about>
2 changes: 1 addition & 1 deletion examples/getting_started/4-Gridded_Datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"As usual, the unspecified key dimension \"Time\" has become a slider widget, which allows you to scrub through the images for each time, and you can also play the frames as an animation in forward or reverse by pressing the ``P`` and ``R`` keys (respectively) after clicking on the slider. \n",
"As usual, the unspecified key dimension \"Time\" has become a slider widget, which allows you to scrub through the images for each time.\n",
"\n",
"Once you have selected an individual plot, you can interact with it by zooming (which does not happen to give additional detail with this particular downsampled dataset), or by selecting the ``Box select`` tool in the plot toolbar and drawing a Fluorescence range on the Histogram to control the color mapping range. \n",
"\n",
Expand Down
14 changes: 6 additions & 8 deletions examples/reference/elements/bokeh/Area.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<div class=\"contentcontainer med left\" style=\"margin-left: -50px;\">\n",
"<dl class=\"dl-horizontal\">\n",
" <dt>Title</dt> <dd> Area Element</dd>\n",
" <dt>Dependencies</dt> <dd>Bokeh</dd>\n",
" <dt>Backends</dt> <dd><a href='./Area.ipynb'>Bokeh</a></dd> <dd><a href='../matplotlib/Area.ipynb'>Matplotlib</a></dd> <dd><a href='../plotly/Area.ipynb'>Plotly</a></dd>\n",
"</dl>\n",
"</div>"
"#### **Title**: Area Element\n",
"\n",
"**Dependencies**: Plotly\n",
"\n",
"**Backends**: [Bokeh](./Area.ipynb), [Matplotlib](../matplotlib/Area.ipynb), [Plotly](../plotly/Area.ipynb)"
]
},
{
Expand Down Expand Up @@ -113,5 +111,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
24 changes: 12 additions & 12 deletions examples/reference/elements/bokeh/Bars.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<div class=\"contentcontainer med left\" style=\"margin-left: -50px;\">\n",
"<dl class=\"dl-horizontal\">\n",
" <dt>Title</dt> <dd> Bars Element</dd>\n",
" <dt>Dependencies</dt> <dd>Bokeh</dd>\n",
" <dt>Backends</dt> <dd><a href='./Bars.ipynb'>Bokeh</a></dd> <dd><a href='../matplotlib/Bars.ipynb'>Matplotlib</a></dd> <dd><a href='../plotly/Bars.ipynb'>Plotly</a></dd>\n",
"</dl>\n",
"</div>"
"#### **Title**: Bars Element\n",
"\n",
"**Dependencies**: Bokeh\n",
"\n",
"**Backends**: [Bokeh](./Bars.ipynb), [Matplotlib](../matplotlib/Bars.ipynb), [Plotly](../plotly/Bars.ipynb)"
]
},
{
Expand Down Expand Up @@ -77,7 +75,9 @@
"source": [
"occupants = hv.Dimension('Car occupants', values=['three', 'two', 'four', 'one', 'five', 'six'])\n",
"\n",
"hv.Bars(data, occupants, 'Count') # or using .redim.values(**{'Car Occupants': ['three', 'two', 'four', 'one', 'five', 'six']})"
"# or using .redim.values(**{'Car Occupants': ['three', 'two', 'four', 'one', 'five', 'six']})\n",
"\n",
"hv.Bars(data, occupants, 'Count') "
]
},
{
Expand All @@ -93,15 +93,15 @@
"metadata": {},
"outputs": [],
"source": [
"N = 100\n",
"samples = 100\n",
"\n",
"pets = ['Cat', 'Dog', 'Hamster', 'Rabbit']\n",
"genders = ['Female', 'Male']\n",
"\n",
"pets_sample = np.random.choice(pets, N)\n",
"gender_sample = np.random.choice(genders, N)\n",
"pets_sample = np.random.choice(pets, samples)\n",
"gender_sample = np.random.choice(genders, samples)\n",
"\n",
"bars = hv.Bars((pets_sample, gender_sample, np.ones(N)), ['Pets', 'Gender']).aggregate(function=np.sum)\n",
"bars = hv.Bars((pets_sample, gender_sample, np.ones(samples)), ['Pets', 'Gender']).aggregate(function=np.sum)\n",
"\n",
"bars.opts(width=500)"
]
Expand Down
17 changes: 6 additions & 11 deletions examples/reference/elements/bokeh/Ellipse.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<div class=\"contentcontainer med left\" style=\"margin-left: -50px;\">\n",
"<dl class=\"dl-horizontal\">\n",
" <dt>Title</dt> <dd> Ellipse Element</dd>\n",
" <dt>Dependencies</dt> <dd>Bokeh</dd>\n",
" <dt>Backends</dt>\n",
" <dd><a href='./Ellipse.ipynb'>Bokeh</a></dd>\n",
" <dd><a href='../matplotlib/Ellipse.ipynb'>Matplotlib</a></dd>\n",
" <dd><a href='../plotly/Ellipse.ipynb'>Plotly</a></dd>\n",
"</dl>\n",
"</div>"
"#### **Title**: Ellipse Element\n",
"\n",
"**Dependencies**: Bokeh\n",
"\n",
"**Backends**: [Bokeh](./Ellipse.ipynb), [Matplotlib](../matplotlib/Ellipse.ipynb), [Plotly](../plotly/Ellipse.ipynb)"
]
},
{
Expand Down Expand Up @@ -92,5 +87,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
2 changes: 1 addition & 1 deletion examples/reference/elements/bokeh/HLine.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"\n",
"**Dependencies**: Bokeh\n",
"\n",
"**Backends**: [Matplotlib](../matplotlib/HLine.ipynb), [Bokeh](./HLine.ipynb)"
"**Backends**: [Matplotlib](../matplotlib/HLine.ipynb), [Bokeh](./HLine.ipynb), [Plotly](../plotly/HLine.ipynb)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/reference/elements/bokeh/Segments.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -217,5 +217,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
17 changes: 6 additions & 11 deletions examples/reference/elements/matplotlib/Area.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<div class=\"contentcontainer med left\" style=\"margin-left: -50px;\">\n",
"<dl class=\"dl-horizontal\">\n",
" <dt>Title</dt> <dd> Area Element</dd>\n",
" <dt>Dependencies</dt> <dd>Matplotlib</dd>\n",
" <dt>Backends</dt>\n",
" <dd><a href='./Area.ipynb'>Bokeh</a></dd>\n",
" <dd><a href='../matplotlib/Area.ipynb'>Matplotlib</a></dd>\n",
" <dd><a href='../plotly/Area.ipynb'>Plotly</a></dd>\n",
"</dl>\n",
"</div>"
"#### **Title**: Area Element\n",
"\n",
"**Dependencies**: Plotly\n",
"\n",
"**Backends**: [Bokeh](../bokeh/Area.ipynb), [Matplotlib](./Area.ipynb), [Plotly](../plotly/Area.ipynb)"
]
},
{
Expand Down Expand Up @@ -116,5 +111,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
24 changes: 12 additions & 12 deletions examples/reference/elements/matplotlib/Bars.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<div class=\"contentcontainer med left\" style=\"margin-left: -50px;\">\n",
"<dl class=\"dl-horizontal\">\n",
" <dt>Title</dt> <dd> Bars Element</dd>\n",
" <dt>Dependencies</dt> <dd>Matplotlib</dd>\n",
" <dt>Backends</dt> <dd><a href='./Bars.ipynb'>Matplotlib</a></dd> <dd><a href='../bokeh/Bars.ipynb'>Bokeh</a></dd> <dd><a href='../plotly/Bars.ipynb'>Plotly</a></dd>\n",
"</dl>\n",
"</div>"
"#### **Title**: Bars Element\n",
"\n",
"**Dependencies**: Matplotlib\n",
"\n",
"**Backends**: [Bokeh](../bokeh/Bars.ipynb), [Matplotlib](./Bars.ipynb), [Plotly](../plotly/Bars.ipynb)"
]
},
{
Expand Down Expand Up @@ -77,7 +75,9 @@
"source": [
"occupants = hv.Dimension('Car occupants', values=['three', 'two', 'four', 'one', 'five', 'six'])\n",
"\n",
"hv.Bars(data, occupants, 'Count') # or using .redim.values(**{'Car Occupants': ['three', 'two', 'four', 'one', 'five', 'six']})"
"# or using .redim.values(**{'Car Occupants': ['three', 'two', 'four', 'one', 'five', 'six']})\n",
"\n",
"hv.Bars(data, occupants, 'Count') "
]
},
{
Expand All @@ -93,15 +93,15 @@
"metadata": {},
"outputs": [],
"source": [
"N = 100\n",
"samples = 100\n",
"\n",
"pets = ['Cat', 'Dog', 'Hamster', 'Rabbit']\n",
"genders = ['Female', 'Male']\n",
"\n",
"pets_sample = np.random.choice(pets, N)\n",
"gender_sample = np.random.choice(genders, N)\n",
"pets_sample = np.random.choice(pets, samples)\n",
"gender_sample = np.random.choice(genders, samples)\n",
"\n",
"bars = hv.Bars((pets_sample, gender_sample, np.ones(N)), ['Pets', 'Gender']).aggregate(function=np.sum)\n",
"bars = hv.Bars((pets_sample, gender_sample, np.ones(samples)), ['Pets', 'Gender']).aggregate(function=np.sum)\n",
"\n",
"bars.opts(fig_size=300, aspect=2)"
]
Expand Down
17 changes: 6 additions & 11 deletions examples/reference/elements/matplotlib/Ellipse.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<div class=\"contentcontainer med left\" style=\"margin-left: -50px;\">\n",
"<dl class=\"dl-horizontal\">\n",
" <dt>Title</dt> <dd> Ellipse Element</dd>\n",
" <dt>Dependencies</dt> <dd>Matplotlib</dd>\n",
" <dt>Backends</dt>\n",
" <dd><a href='./Ellipse.ipynb'>Matplotlib</a></dd>\n",
" <dd><a href='../bokeh/Ellipse.ipynb'>Bokeh</a></dd>\n",
" <dd><a href='../plotly/Ellipse.ipynb'>Plotly</a></dd>\n",
"</dl>\n",
"</div>"
"#### **Title**: Ellipse Element\n",
"\n",
"**Dependencies**: Plotly\n",
"\n",
"**Backends**: [Bokeh](../bokeh/Ellipse.ipynb), [Matplotlib](./Ellipse.ipynb), [Plotly](../plotly/Ellipse.ipynb)"
]
},
{
Expand Down Expand Up @@ -86,5 +81,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
2 changes: 1 addition & 1 deletion examples/reference/elements/matplotlib/HLine.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"\n",
"**Dependencies**: Matplotlib\n",
"\n",
"**Backends**: [Bokeh](../bokeh/HLine.ipynb), [Matplotlib](./HLine.ipynb)"
"**Backends**: [Bokeh](../bokeh/HLine.ipynb), [Matplotlib](./HLine.ipynb), [Plotly](../plotly/HLine.ipynb)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/reference/elements/matplotlib/Segments.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -174,5 +174,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
2 changes: 1 addition & 1 deletion examples/reference/elements/matplotlib/VLine.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"\n",
"**Dependencies**: Matplotlib\n",
"\n",
"**Backends**: [Bokeh](../bokeh/VLine.ipynb), [Matplotlib](./VLine.ipynb)"
"**Backends**: [Matplotlib](./VLine.ipynb), [Bokeh](../bokeh/VLine.ipynb), [Plotly](../plotly/VLine.ipynb)"
]
},
{
Expand Down
14 changes: 6 additions & 8 deletions examples/reference/elements/plotly/Area.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<div class=\"contentcontainer med left\" style=\"margin-left: -50px;\">\n",
"<dl class=\"dl-horizontal\">\n",
" <dt>Title</dt> <dd> Area Element</dd>\n",
" <dt>Dependencies</dt> <dd>Plotly</dd>\n",
" <dt>Backends</dt> <dd><a href='./Area.ipynb'>Bokeh</a></dd> <dd><a href='../matplotlib/Area.ipynb'>Matplotlib</a></dd> <dd><a href='../plotly/Area.ipynb'>Plotly</a></dd>\n",
"</dl>\n",
"</div>"
"#### **Title**: Area Element\n",
"\n",
"**Dependencies**: Plotly\n",
"\n",
"**Backends**: [Bokeh](../bokeh/Area.ipynb), [Matplotlib](../matplotlib/Area.ipynb), [Plotly](./Area.ipynb)"
]
},
{
Expand Down Expand Up @@ -115,5 +113,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
Loading

0 comments on commit 7e23dff

Please sign in to comment.