Skip to content

Commit 93f6b69

Browse files
committed
Update docs
1 parent 2b72238 commit 93f6b69

8 files changed

+9503
-1555
lines changed

CHANGELOG.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
v1.1.8 (unreleased)
3+
===================
4+
-
5+
6+
v1.1.7
7+
======
8+
- generalise handling of multiple samples in dataset

docs/index.rst

+20-38
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,6 @@
66
Welcome to sankeyview's documentation!
77
=======================================
88

9-
.. toctree::
10-
:maxdepth: 2
11-
:hidden:
12-
13-
introduction
14-
introduction/Introductory example
15-
jupyter
16-
api
17-
18-
199
.. image:: sankeyview_overview.png
2010

2111
Sankeyview generates Sankey diagrams from a dataset of flows. For a descriptive
@@ -24,45 +14,37 @@ multidimensional data for understanding resource use
2414
<https://doi.org/10.1016/j.resconrec.2017.05.002>`_. For a more hands-on
2515
introduction, read on.
2616

27-
Installation
28-
============
29-
30-
Install sankeyview using pip:
31-
32-
.. code-block:: shell
33-
34-
$ pip install sankeyview
17+
Getting started
18+
---------------
3519

36-
If you use Jupyter notebooks -- a good way to get started -- you will also want
37-
to install `ipysankeywidget <https://github.com/ricklupton/ipysankeywidget>`_,
38-
an IPython widget to interactively display Sankey diagrams::
20+
Start by installing sankeyview:
3921

40-
$ pip install ipysankeywidget
41-
$ jupyter nbextension enable --py --sys-prefix ipysankeywidget
22+
.. toctree::
4223

43-
.. note::
24+
installation
4425

45-
If this is the first time you have installed IPython widgets, you also need to
46-
make sure they are enabled::
26+
Then the tutorials introduce the concepts used to generate and manipulate Sankey
27+
diagrams:
4728

48-
$ jupyter nbextension enable --py --sys-prefix widgetsnbextension
29+
.. toctree::
4930

50-
If you use multiple virtualenvs or conda environments, make sure
51-
``ipywidgets`` and ``ipysankeywidget`` are installed and enabled in both the
52-
environment running the notebook server and the kernel.
31+
tutorials/Quickstart
32+
tutorials/Showing fewer flows
5333

54-
Getting started
55-
===============
34+
Documentation
35+
-------------
5636

57-
Start with the :ref:`introduction`, which introduces the concepts used to
58-
generate and manipulate Sankey diagrams.
37+
The easiest way to use sankeyview is through the interactive
38+
:ref:`Jupyter-interface`. The API pages describe the objects that describe the
39+
diagrams.
5940

60-
The easiest way to use sankeyview is through the interactive :ref:`Jupyter-interface`.
41+
.. toctree::
6142

62-
Alternatively, for more control you can use the :ref:`full-api`.
43+
jupyter
44+
api
6345

6446
Citing sankeyview
65-
=================
47+
-----------------
6648

6749
If sankeyview has been significant in a project that leads to a publication,
6850
please acknowledge that by citing `the paper linked above
@@ -75,7 +57,7 @@ please acknowledge that by citing `the paper linked above
7557

7658

7759
Indices and tables
78-
==================
60+
------------------
7961

8062
* :ref:`genindex`
8163
* :ref:`modindex`

docs/installation.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Installation
2+
============
3+
4+
Install sankeyview using pip:
5+
6+
.. code-block:: shell
7+
8+
$ pip install sankeyview
9+
10+
If you use Jupyter notebooks -- a good way to get started -- you will also want
11+
to install `ipysankeywidget <https://github.com/ricklupton/ipysankeywidget>`_,
12+
an IPython widget to interactively display Sankey diagrams::
13+
14+
$ pip install ipysankeywidget
15+
$ jupyter nbextension enable --py --sys-prefix ipysankeywidget
16+
17+
.. note::
18+
19+
If this is the first time you have installed IPython widgets, you also need to
20+
make sure they are enabled::
21+
22+
$ jupyter nbextension enable --py --sys-prefix widgetsnbextension
23+
24+
If you use multiple virtualenvs or conda environments, make sure
25+
``ipywidgets`` and ``ipysankeywidget`` are installed and enabled in both the
26+
environment running the notebook server and the kernel.

docs/introduction.rst

-4
This file was deleted.

0 commit comments

Comments
 (0)