Skip to content

Commit 2598e6b

Browse files
committed
Updated docs.
1 parent 46e4a7d commit 2598e6b

File tree

3 files changed

+27
-41
lines changed

3 files changed

+27
-41
lines changed

CHANGES.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Release 0.1.0
1+
Release 1.0.0-rc1
22
=========================================
33

4-
* First public release
4+
* First public release: **Release Candidate 1**

docs/_contributors.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
* Chris Modzelewski (`@insightindustry <https://github.com/insightindustry>`_)
1+
* Chris Modzelewski (`@hcpchris <https://github.com/hcpchris>`__ / `@insightindustry <https://github.com/insightindustry>`__)
2+
* Erin Modzelewski (`@EBModz <https://github.com/EBModz>`__)

docs/toolkit.rst

Lines changed: 23 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The Toolkit's Contents
77
****************************
88

99
The **Highcharts for Python** toolkit features a number of separate Python
10-
libraries which extend the core **Highcharts for Python** (``highcharts-core``) library.
11-
This pattern actually maps quite naturally to the Highcharts JS design, where multiple
10+
libraries which extend the core **Highcharts Core for Python** (``highcharts-core``) library.
11+
This pattern maps quite naturally to the Highcharts JS design, where multiple
1212
other modules extend the core Highcharts JS library.
1313

1414
The **Highcharts for Python** toolkit includes two categories of tools:
@@ -18,24 +18,30 @@ The **Highcharts for Python** toolkit includes two categories of tools:
1818
.. tab:: Core Visualization Libraries
1919

2020
These libraries correspond to each of the major Highcharts
21-
`products <https://www.highcharts.com/blog/products/>`_:
21+
`products <https://www.highcharts.com/products/>`__:
2222

23-
* **Highcharts for Python**: This is the foundational Python library, and is required
23+
* **Highcharts Core for Python**: This is the foundational Python library, and is required
2424
by all other components in the toolkit. It provides the fundamental Python classes
2525
that are used throughout the toolkit, and importantly provides 100% coverage for the
2626
functionality in the
27-
`Highcharts JS <https://www.highcharts.com/blog/products/#highcharts>`_ JavaScript
27+
`Highcharts Core <https://www.highcharts.com/products/highcharts>`__ JavaScript
2828
library.
2929
* **Highcharts Stock for Python**: This is the Python wrapper for the
30-
`Highcharts Stock <https://www.highcharts.com/blog/products/#highcharts-stock>`_
30+
`Highcharts Stock <https://www.highcharts.com/products/stock>`__
3131
JavaScript library, which provides extensive visualizations for time series and
3232
stock price visualizations. For more details, please see the relevant
33-
`Highcharts Stock for Python documentation <https://highcharts-stock.readthedocs.io>`_
33+
`Highcharts Stock for Python documentation <https://highcharts-stock.readthedocs.io>`__
3434
* **Highcharts Maps for Python**: This is the Python wrapper for the
35-
`Highcharts Maps <https://www.highcharts.com/blog/products/#highcharts-maps>`_
35+
`Highcharts Maps <https://www.highcharts.com/products/maps>`__
3636
JavaScript library, which provides extensive geographic data visualization options
3737
with rich interactive maps. For more details, please see the relevant
38-
`Highcharts Maps for Python documentation <https://highcharts-maps.readthedocs.io>`_
38+
`Highcharts Maps for Python documentation <https://highcharts-maps.readthedocs.io>`__
39+
* **Highcharts Gantt for Python**: This is the Python wrapper for the
40+
`Highcharts Gantt <https://www.highcharts.com/products/gantt>`__
41+
JavaScript library, which provides rich visualizations for resource allocation over
42+
time. For more details, please see the relevant
43+
`Highcharts Gantt for Python documentation <https://highcharts-gantt.readthedocs.io>`__
44+
3945

4046
.. tab:: Extensions
4147

@@ -45,25 +51,7 @@ The **Highcharts for Python** toolkit includes two categories of tools:
4551

4652
.. note::
4753

48-
The libraries below are in-progress, but have not yet been released.
49-
50-
* **Highcharts Gantt for Python**: This is the Python wrapper for the
51-
`Highcharts Gantt <https://www.highcharts.com/blog/products/#highcharts>`_
52-
JavaScript library, which provides rich visualizations for resource allocation over
53-
time. For more details, please see the relevant
54-
`Highcharts Gantt for Python documentation <https://highcharts-gantt.readthedocs.io>`_
55-
* **Highcharts for Dash**: This is a set of components for the
56-
`Dash <https://dash.plotly.com/>`_ data visualization framework which makes it easy
57-
to use Highcharts visualizations in your Dash dashboards. For more details, please
58-
see the relevant `Highcharts for Dash documentation <https://highcharts-dash.readthedocs.io>`_.
59-
* **Flask-Highcharts**: This is an extension to the Flask microframework which makes
60-
integrating Highcharts visualizations into Flask views super simple. For more
61-
details, please see the relevant
62-
`Flask-Highcharts documentation <https://flask-highcharts.readthedocs.io>`_.
63-
* **Highcharts for Django**: This is an extension to the Django web framework which
64-
makes utilizing Highcharts visualizations in your Django application super simple.
65-
For more details, please see the
66-
`Highcharts for Django documentation <https://highcharts-django.readthedocs.io>`_.
54+
A number of extension libraries are in progress, but have not yet been released. Watch this space for news soon!
6755

6856
.. note::
6957

@@ -85,7 +73,11 @@ project project repo, the lists below provides some high-level information.
8573

8674
.. tab:: Core Visualization Libraries
8775

88-
* Support for Explicit Defaults ( :issue:`1` ). Currently, Highcharts default values
76+
* Needed Script Tags ( :issue:`12` ). It would be helpful for **Highcharts for Python**
77+
to support the production of the relevant ``<script/>`` tags needed to include the
78+
Highcharts JS modules that are needed to render a specific chart (and to *not*
79+
include the modules that are not needed).
80+
* Support for Explicit Defaults ( :issue:`13` ). Currently, Highcharts default values
8981
are always presented as :obj:`None <python:None>` in outputs within Python, and are
9082
stripped from the serialized JSON or JS literal representation of all objects
9183
(because that way the Highcharts JS library applies its default). While this is
@@ -95,21 +87,14 @@ project project repo, the lists below provides some high-level information.
9587
Zen of Python spirit that "explicit is better than implicit", there needs to be a
9688
mechanism for users of the library to *explicitly* request that default values are
9789
accessible in Python and shown when serializing the chart configuration.
98-
* Needed Script Tags ( :issue:`2` ). It would be helpful for **Highcharts for Python**
99-
to support the production of the relevant ``<script/>`` tags needed to include the
100-
Highcharts JS modules that are needed to render a specific chart (and to *not*
101-
include the modules that are not needed).
102-
* Styled Mode Configuration ( :issue:`7` ). While :term:`styled mode` can currently be
90+
* Styled Mode Configuration ( :issue:`14` ). While :term:`styled mode` can currently be
10391
enabled in **Highcharts for Python**, the library does not provide for the actual
10492
definition or configuration of Highcharts CSS. It would be good if it did, so that
10593
all Highcharts-related configuration could be handled within the library.
10694

10795
.. tab:: Extensions
10896

109-
* Implement and release **Highcharts Gantt for Python** ( :issue:`6` ).
110-
* Implement and release **Highcharts for Dash** ( :issue:`3` ).
111-
* Implement and release **Flask-Highcharts** ( :issue:`4` ).
112-
* Implement and release **Highcharts for Django** ( :issue:`5` ).
97+
* Watch this space...we'll be announcing some new extensions soon.
11398

11499
********************************
115100
Additional Tools Needed?

0 commit comments

Comments
 (0)