Merge pull request #24 from highcharts-for-python/develop

PR for v.1.0.0-rc4

Author: hcpchris

.readthedocs.yaml

@@ -14,6 +14,8 @@ build:
     # nodejs: "19"
     # rust: "1.64"
     # golang: "1.19"
+  apt_packages:
+    - graphviz
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

CHANGES.rst

@@ -1,3 +1,10 @@
+Release 1.0.0-rc4
+=========================================
+
+* Revised the documentation.
+
+---------------
+
 Release 1.0.0-rc3
 =========================================
 

README.rst

@@ -41,10 +41,10 @@ which together provides comprehensive support across the entire
   * - `Highcharts Stock for Python <https://stock-docs.highchartspython.com/>`__ 
     - `Highcharts Stock (JS) <https://www.highcharts.com/products/stock/>`__
     - the time series visualization extension to Highcharts Core
-  * - `Highcharts Maps <https://maps-docs.highchartspython.com/>`__ 
+  * - `Highcharts Maps for Python <https://maps-docs.highchartspython.com/>`__ 
     - `Highcharts Maps (JS) <https://www.highcharts.com/products/maps/>`__
     - the map visualization extension to Highcharts Core
-  * - `Highcharts Gantt <https://gantt-docs.highchartspython.com/>`__
+  * - `Highcharts Gantt for Python <https://gantt-docs.highchartspython.com/>`__
     - `Highcharts Gantt (JS) <https://www.highcharts.com/products/gantt/>`__
     - the Gantt charting extension to Highcharts Core
   * - (all libraries in the Python toolkit)

docs/_dependencies.rst

@@ -24,7 +24,7 @@
 
         $ pip install highcharts-core
 
-    * `Highcharts JS <https://www.highcharts.com>`__ v.10.2 or higher
+    * `Highcharts Core <https://www.highcharts.com/products/highcharts/>`__ v.10.2 or higher
 
       .. note::
 

docs/api/_handling_defaults.rst

@@ -5,7 +5,7 @@
 default values are generally applied if a JavaScript property is ``undefined`` (missing or
 otherwise not specified), which is different from the JavaScript value of ``null``.
 
-While my Pythonic instinct is to:
+While our Pythonic instinct is to:
 
   * indicate those default values explicitly in the **Highcharts for Python** code as
     keyword argument defaults, and

docs/contributing.rst

@@ -217,7 +217,7 @@ Design Patterns and Standards
 JavaScript libraries. If in doubt, take a look at the extensive 
 `documentation <https://www.highcharts.com/docs/index>`_ and in particular the 
 `API reference <https://api.highcharts.com/highcharts>`_.  Because 
-**Highcharts for Python** wraps the Highcharts JS API, its design is heavily shaped by 
+**Highcharts for Python** wraps the Highcharts Core API, its design is heavily shaped by 
 Highcharts JS' own design - as one should expect.
 
 However, one of the main goals of **Highcharts for Python** is to make the Highcharts JS

docs/index.rst

@@ -25,7 +25,7 @@ Highcharts Core for Python
   Supported Visualizations <visualizations>
   FAQ <faq>
   Toolkit Components and Roadmap <toolkit>
-  Using Highcharts for Python <using>
+  Using Highcharts Core for Python <using>
   API Reference <api>
   Error Reference <errors>
   Getting Help <support>
@@ -40,7 +40,7 @@ Highcharts Core for Python
   **Highcharts Core for Python** is designed to be compatible with:
 
     * Python 3.10 or higher,
-    * Highcharts JS 10.2 or higher,
+    * Highcharts Core (JS) 10.2 or higher,
     * Jupyter Notebook 6.4 or higher,
     * IPython 8.10 or higher,
     * Pandas 1.3 or higher
@@ -85,10 +85,10 @@ which together provides comprehensive support across the entire
   * - `Highcharts Stock for Python <https://stock-docs.highchartspython.com/>`__ 
     - `Highcharts Stock (JS) <https://www.highcharts.com/products/stock/>`__
     - the time series visualization extension to Highcharts Core
-  * - `Highcharts Maps <https://maps-docs.highchartspython.com/>`__ 
+  * - `Highcharts Maps for Python <https://maps-docs.highchartspython.com/>`__ 
     - `Highcharts Maps (JS) <https://www.highcharts.com/products/maps/>`__
     - the map visualization extension to Highcharts Core
-  * - `Highcharts Gantt <https://gantt-docs.highchartspython.com/>`__
+  * - `Highcharts Gantt for Python <https://gantt-docs.highchartspython.com/>`__
     - `Highcharts Gantt (JS) <https://www.highcharts.com/products/gantt/>`__
     - the Gantt charting extension to Highcharts Core
   * - (all libraries in the Python toolkit)

highcharts_core/__version__.py

@@ -1 +1 @@
-__version__ = '1.0.0-rc3'
+__version__ = '1.0.0-rc4'