Updated API docs.

Author: hcpchris

docs/api.rst

@@ -1,8 +1,8 @@
-`Highcharts Stock <https://www.highcharts.com/products/stock/>`__ objects re-use many of
+`Highcharts Gantt <https://www.highcharts.com/products/gantt/>`__ objects re-use many of
 the same properties. This is one of the strengths of the Highcharts API, in that it is
 internally consistent and that behavior configured on one object should be readily
 transferrable to a second object provided it shares the same properties. However,
-Highcharts Stock has a *lot* of properties. For example, I estimate that
+Highcharts Gantt has a *lot* of properties. For example, I estimate that
 the ``options.plotOptions`` objects and their sub-properties have close to 3,000
 properties. But because they are heavily repeated, those 3,000 or so properties can be
 reduced to only 421 unique property names. That's almost an 85% reduction.

docs/api/_class_structures.rst

@@ -1,7 +1,7 @@
   *Explicit is better than implicit.*
   -- The Zen of Python
 
-`Highcharts Stock <https://www.highcharts.com/products/stock/>`__ has a *lot* of default
+`Highcharts Gantt <https://www.highcharts.com/products/gantt/>`__ has a *lot* of default
 values. These 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``.
@@ -16,25 +16,25 @@ While my Pythonic instinct is to:
 doing so would introduce a massive problem: It would bloat data transferred on the wire
 *unnecessarily*.
 
-The way that `Highcharts Stock <https://www.highcharts.com/products/stock/>`__ handles
+The way that `Highcharts Gantt <https://www.highcharts.com/products/gantt/>`__ handles
 defaults is an elegant compromise between explicitness and the practical reality of making
 your code readable. Why make a property explicit in a configuration string if you don't
 care about it? Purity is only valuable to a point. And with thousands of properties across
-the `Highcharts JS <https://www.highcharts.com/products/highcharts/>`__ and
-`Highcharts Stock <https://www.highcharts.com/products/stock/>`__ libraries, *nobody*
+the `Highcharts Core <https://www.highcharts.com/products/highcharts/>`__ and
+`Highcharts Gantt <https://www.highcharts.com/products/gantt/>`__ libraries, *nobody*
 wants to transmit or maintain thousands of property configurations if it can be avoided.
 
 For that reason, the **Highcharts for Python** toolkit explicitly breaks Pythonic
 convention: when an object's property returns :obj:`None <python:None>`, that has the
 equivalent meaning of "Highcharts JS/Stock will apply the Highcharts default for this
 property". These properties will *not* be serialized, either to a JS literal, nor to a
 :class:`dict <python:dict>`, nor to JSON. This has the advantage of maintaining consistent
-behavior with `Highcharts JS <https://www.highcharts.com/products/highcharts/>`__ and
-`Highcharts Stock <https://www.highcharts.com/products/stock/>`__ while still providing an
+behavior with `Highcharts Core <https://www.highcharts.com/products/highcharts/>`__ and
+`Highcharts Gantt <https://www.highcharts.com/products/gantt/>`__ while still providing an
 internally consistent logic to follow.
 
 .. note::
 
   There's an item on the **Highcharts for Python** :doc:`roadmap <../toolkit>`
-  (:issue:`1`) to *optionally* surface defaults when explicitly requested. Not sure when
+  (:issue:`8`) to *optionally* surface defaults when explicitly requested. Not sure when
   it will be implemented, but we'll get there at some point.

docs/api/_handling_defaults.rst

@@ -1,43 +1,43 @@
 
-The structure of the **Highcharts Stock for Python** library closely matches the structure
-of the `Highcharts Stock <https://www.highcharts.com/products/stock/>`__ options object (see the relevant
-`reference documentation <https://api.highcharts.com/highstock/>`_).
+The structure of the **Highcharts Gantt for Python** library closely matches the structure
+of the `Highcharts Gantt <https://www.highcharts.com/products/gantt/>`__ options object (see the relevant
+`reference documentation <https://api.highcharts.com/gantt/>`_).
 
-At the root of the library - importable from ``highcharts_stock`` - you will find the
-:mod:`highcharts_stock.highcharts` module. This module is a catch-all importable module,
-which allows you to easily access the most-commonly-used Highcharts Stock for Python
+At the root of the library - importable from ``highcharts_gantt`` - you will find the
+:mod:`highcharts_gantt.highcharts` module. This module is a catch-all importable module,
+which allows you to easily access the most-commonly-used Highcharts Gantt for Python
 classes and modules.
 
 .. note::
 
-  Whlie you can access all of the **Highcharts Stock for Python** classes from
-  ``highcharts_stock.highcharts``, if you want to more precisely navigate to specific
+  Whlie you can access all of the **Highcharts Gantt for Python** classes from
+  ``highcharts_gantt.highcharts``, if you want to more precisely navigate to specific
   class definitions you can do fairly easily using the module organization and naming
   conventions used in the library.
 
-  In the root of the ``highcharts_stock`` library you can find universally-shared
-  class definitions, like :mod:`.metaclasses <highcharts_stock.metaclasses>` which
-  contains the :class:`HighchartsMeta <highcharts_stock.metaclasses.HighchartsMeta>`
-  and :class:`JavaScriptDict <highcharts_stock.metaclasses.JavaScriptDict>`
-  definitions, or :mod:`.decorators <highcharts_stock.decorators>` which define
+  In the root of the ``highcharts_gantt`` library you can find universally-shared
+  class definitions, like :mod:`.metaclasses <highcharts_gantt.metaclasses>` which
+  contains the :class:`HighchartsMeta <highcharts_gantt.metaclasses.HighchartsMeta>`
+  and :class:`JavaScriptDict <highcharts_gantt.metaclasses.JavaScriptDict>`
+  definitions, or :mod:`.decorators <highcharts_gantt.decorators>` which define
   method/property decorators that are used throughout the library.
 
-  The :mod:`.utility_classes <highcharts_stock.utility_classes>` module contains class
+  The :mod:`.utility_classes <highcharts_gantt.utility_classes>` module contains class
   definitions for classes that are referenced or used throughout the other class
   definitions.
 
-  And you can find the Highcharts Stock ``options`` object and all of its
-  properties defined in the :mod:`.options <highcharts_stock.options>` module, with
+  And you can find the Highcharts Gantt ``options`` object and all of its
+  properties defined in the :mod:`.options <highcharts_gantt.options>` module, with
   specific (complicated or extensive) sub-modules providing property-specific classes
-  (e.g. the :mod:`.options.plot_options <highcharts_stock.options.plot_options>`
+  (e.g. the :mod:`.options.plot_options <highcharts_gantt.options.plot_options>`
   module defines all of the different configuration options for different series types,
-  while the :mod:`.options.series <highcharts_stock.options.series>` module defines all
+  while the :mod:`.options.series <highcharts_gantt.options.series>` module defines all
   of the classes that represent :term:`series` of data in a given chart).
 
 .. tip::
 
   To keep things simple, we recommend importing classes you need directly from the
-  :mod:`highcharts_stock.highcharts` module. There are two paths to do so easily:
+  :mod:`highcharts_gantt.highcharts` module. There are two paths to do so easily:
 
   .. code-block:: python
 
@@ -51,7 +51,7 @@ classes and modules.
     my_line_series = highcharts.options.series.area.LineSeries()
 
     # APPROACH #2: Import a specific class or module by name from the "highcharts" module.
-    from highcharts_stock.highcharts import Chart, SharedStockOptions, options
+    from highcharts_gantt.highcharts import Chart, SharedStockOptions, options
 
     my_chart = Chart()
     my_shared_options = SharedStockOptions()

docs/api/_module_structure.rst

@@ -6,14 +6,14 @@
 
     :param other: The target instance to which the properties of this instance should
       be copied.
-    :type other: :class:`HighchartsMeta <highcharts_stock.metaclasses.HighchartsMeta>`
+    :type other: :class:`HighchartsMeta <highcharts_gantt.metaclasses.HighchartsMeta>`
 
     :param overwrite: if ``True``, properties in ``other`` that are already set will
       be overwritten by their counterparts in ``self``. Defaults to ``True``.
     :type overwrite: :class:`bool <python:bool>`
 
     :param kwargs: Additional keyword arguments. Some special descendants of
-      :class:`HighchartsMeta <highcharts_stock.metaclasses.HighchartsMeta>` may have
+      :class:`HighchartsMeta <highcharts_gantt.metaclasses.HighchartsMeta>` may have
       special implementations of this method which rely on additional keyword arguments.
 
     :returns: A mutated version of ``other`` with new property values

docs/api/_other_convenience_methods.rst

@@ -2,7 +2,7 @@
   .. method:: to_js_literal(self, filename = None, encoding = 'utf-8')
     :noindex:
 
-    Convert the **Highcharts Stock for Python** instance to Highcharts Stock-compatible
+    Convert the **Highcharts Gantt for Python** instance to Highcharts Gantt-compatible
     JavaScript code using :term:`JavaScript object literal notation`.
 
     :param filename: If supplied, persists the JavaScript code to the file indicated.
@@ -13,15 +13,15 @@
       literal string. Defaults to ``'utf-8'``.
     :type encoding: :class:`str <python:str>`
 
-    :returns: Highcharts Stock-compatible JavaScript code using
+    :returns: Highcharts Gantt-compatible JavaScript code using
       :term:`JavaScript object literal notation`.
     :rtype: :class:`str <python:str>`
 
 
   .. method:: to_json(self, filename = None, encoding = 'utf-8')
     :noindex:
 
-    Convert the **Highcharts Stock for Python** instance to Highcharts Stock-compatible
+    Convert the **Highcharts Gantt for Python** instance to Highcharts Gantt-compatible
     JSON.
 
     .. warning::
@@ -30,7 +30,7 @@
       :term:`JavaScript object literal notation`. In particular, it cannot include
       JavaScript functions. This means if you try to convert a Highcharts for Python object
       to JSON, any properties that are
-      :class:`CallbackFunction <highcharts_stock.utility_classes.javascript_functions.CallbackFunction>`
+      :class:`CallbackFunction <highcharts_gantt.utility_classes.javascript_functions.CallbackFunction>`
       instances will not be included. If you want to convert those functions, please use
       ``.to_js_literal()`` instead.
 
@@ -42,12 +42,12 @@
       Defaults to ``'utf-8'``.
     :type encoding: :class:`str <python:str>`
 
-    :returns: Highcharts Stock-compatible JSON representation of the object.
+    :returns: Highcharts Gantt-compatible JSON representation of the object.
     :rtype: :class:`str <python:str>` or :class:`bytes <python:bytes>`
 
       .. note::
 
-        **Highcharts Stock for Python** works with different JSON encoders. If your
+        **Highcharts Gantt for Python** works with different JSON encoders. If your
         environment has `orjson <https://github.com/ijl/orjson>`_, for example, the result
         will be returned as a :class:`bytes <python:bytes>` instance. Otherwise, the
         library will fallback to various other JSON encoders until finally falling back to
@@ -57,8 +57,8 @@
   .. method:: to_dict(self)
     :noindex:
 
-    Convert the **Highcharts Stock for Python** object into a Highcharts Stock-compatible
+    Convert the **Highcharts Gantt for Python** object into a Highcharts Gantt-compatible
     :class:`dict <python:dict>` object.
 
-    :returns: Highcharts Stock-compatible :class:`dict <python:dict>` object
+    :returns: Highcharts Gantt-compatible :class:`dict <python:dict>` object
     :rtype: :class:`dict <python:dict>`

docs/api/_serialization_methods.rst

@@ -1,5 +1,5 @@
 ##################################################
-:mod:`.chart <highcharts_stock.chart>`
+:mod:`.chart <highcharts_gantt.chart>`
 ##################################################
 
 .. contents:: Module Contents
@@ -9,10 +9,10 @@
 
 --------------
 
-.. module:: highcharts_stock.chart
+.. module:: highcharts_gantt.chart
 
 ******************************************************
-class: :class:`Chart <highcharts_stock.chart.Chart>`
+class: :class:`Chart <highcharts_gantt.chart.Chart>`
 ******************************************************
 
 .. autoclass:: Chart
@@ -22,7 +22,7 @@ class: :class:`Chart <highcharts_stock.chart.Chart>`
   .. collapse:: Class Inheritance
 
     .. inheritance-diagram:: Chart
-      :top-classes: highcharts_stock.metaclasses.HighchartsMeta, highcharts_core.metaclasses.HighchartsMeta
+      :top-classes: highcharts_gantt.metaclasses.HighchartsMeta, highcharts_core.metaclasses.HighchartsMeta
       :parts: -1
 
   |