Updated docs/using/

Author: hcpchris

docs/_static/asana-project-gid.png

@@ -1,7 +1,7 @@
   *There are only two hard things in Computer Science: cache invalidation and naming
   things.* -- Phil Karlton
 
-Highcharts Stock is a JavaScript library, and as such it adheres to the code conventions
+Highcharts Gantt is a JavaScript library, and as such it adheres to the code conventions
 that are popular (practically standard) when working in JavaScript. Chief among these
 conventions is that variables and object properties (keys) are typically written in
 ``camelCase``.

docs/_static/monday-board-id.png

@@ -6,36 +6,36 @@
 
       **Best Practice!**
 
-      This method of importing **Highcharts Stock for Python** objects yields the fastest
+      This method of importing **Highcharts Gantt for Python** objects yields the fastest
       performance for the ``import`` statement. However, it is more verbose and requires
-      you to navigate the extensive :doc:`Highcharts Stock for Python API </api>`.
+      you to navigate the extensive :doc:`Highcharts Gantt for Python API </api>`.
 
     .. code-block:: python
 
       # Import classes using precise module indications. For example:
-      from highcharts_stock.chart import Chart
-      from highcharts_stock.global_options.shared_options import SharedStockOptions
-      from highcharts_stock.options import HighchartsStockOptions
-      from highcharts_stock.options.plot_options.bar import BarOptions
-      from highcharts_stock.options.series.bar import BarSeries
+      from highcharts_gantt.chart import Chart
+      from highcharts_gantt.global_options.shared_options import SharedGanttOptions
+      from highcharts_gantt.options import HighchartsGanttOptions
+      from highcharts_gantt.options.plot_options.gantt import GanttOptions
+      from highcharts_gantt.options.series.gantt import GanttSeries
 
   .. tab:: from ``.highcharts``
 
     .. caution::
 
-      This method of importing **Highcharts Stock for Python** classes has relatively slow
+      This method of importing **Highcharts Gantt for Python** classes has relatively slow
       performance because it imports hundreds of different classes from across the entire
       library. This performance impact may be acceptable to you in your use-case, but
       do use at your own risk.
 
     .. code-block:: python
 
       # Import objects from the catch-all ".highcharts" module.
-      from highcharts_stock import highcharts
+      from highcharts_gantt import highcharts
 
       # You can now access specific classes without individual import statements.
       highcharts.Chart
-      highcharts.SharedStockOptions
-      highcharts.HighchartsStockOptions
-      highcharts.BarOptions
-      highcharts.BarSeries
+      highcharts.SharedGanttOptions
+      highcharts.HighchartsGanttOptions
+      highcharts.GanttOptions
+      highcharts.GanttSeries

docs/using/_code_style_naming_conventions.rst

@@ -12,20 +12,20 @@
         :align: center
 
     To display the stock tools in your chart, you can use the
-    :meth:`HighchartsStockOptions.stock_tools <highcharts_stock.options.HighchartsStockOptions.stock_tools>`
+    :meth:`HighchartsGanttOptions.stock_tools <highcharts_gantt.options.HighchartsGanttOptions.stock_tools>`
     setting, which can be configured using a
-    :class:`StockTools <highcharts_stock.options.stock_tools.StockTools>` instance.
+    :class:`StockTools <highcharts_gantt.options.stock_tools.StockTools>` instance.
 
       .. code-block:: python
 
         my_stock_tools = StockTools(gui = { 'enabled': True })
-        my_options = HighchartsStockOptions(stock_tools = my_stock_tools)
+        my_options = HighchartsGanttOptions(stock_tools = my_stock_tools)
         my_chart = Chart.from_options(my_options)
 
       .. seealso::
 
-        * :class:`StockTools <highcharts_stock.options.stock_tools.StockTools>`
-        * :class:`StockToolsGUI <highcharts_stock.options.stock_tools.StockToolsGUI>`
+        * :class:`StockTools <highcharts_gantt.options.stock_tools.StockTools>`
+        * :class:`StockToolsGUI <highcharts_gantt.options.stock_tools.StockToolsGUI>`
 
   .. tab:: Navigator
 
@@ -37,10 +37,10 @@
         :alt: Navigator
         :align: center
 
-    The navigator is enabled by default in :class:`Chart <highcharts_stock.chart.Chart>`
-    instances where :meth:`.is_stock_chart <highcharts_stock.chart.Chart.is_stock_chart>`
-    is ``True`` or whose :meth:`.options <highcharts_stock.chart.Chart.options>` contain
-    a :class:`HighchartsStockOptions <highcharts_stock.options.HighchartsStockOptions>`
+    The navigator is enabled by default in :class:`Chart <highcharts_gantt.chart.Chart>`
+    instances where :meth:`.is_stock_chart <highcharts_gantt.chart.Chart.is_stock_chart>`
+    is ``True`` or whose :meth:`.options <highcharts_gantt.chart.Chart.options>` contain
+    a :class:`HighchartsStockOptions <highcharts_gantt.options.HighchartsStockOptions>`
     instance.
 
     You can configure how the navigator is rendered using several different methods:
@@ -53,12 +53,12 @@
         ``PlotOptions.<SERIES TYPE>.show_in_navigator`` and
         ``PlotOptions.<SERIES TYPE>.navigator_options`` properties.
       * You can set overall configuration settings for the entire navigator using the
-        :meth:`HighchartsStockOptions.navigator <highcharts_stock.HighchartsStockOptions.navigator>`
+        :meth:`HighchartsStockOptions.navigator <highcharts_gantt.options.HighchartsStockOptions.navigator>`
         setting.
 
     .. seealso::
 
-      * :class:`Navigator <highcharts_stock.options.navigator.Navigator>`
+      * :class:`Navigator <highcharts_gantt.options.navigator.Navigator>`
 
   .. tab:: Range Selector
 
@@ -71,8 +71,8 @@
         :align: center
 
     Based upon its configuration (via the
-    :meth:`HighchartsStockOptions.options.range_selector <highcharts_stock.options.HighchartsStockOptions.options.range_selector>`
-    property), it can display a series of buttons that allow the user to zoom to a
+    :meth:`HighchartsGanttOptions.range_selector <highcharts_gantt.options.HighchartsGanttOptions.range_selector>` or :meth:`HighchartsStockOptions.range_selector <highcharts_gantt.options.HighchartsStockOptions.range_selector>`
+    properties), it can display a series of buttons that allow the user to zoom to a
     specific granularity (e.g. display one day's worth of data, display one week's worth
     of data, display one month's worth of data, etc.) and can provide the user with inputs
     to select the range (start date / end date) which should be displayed.
@@ -82,10 +82,11 @@
       By default, the range selector is rendered in a responsive fashion. If there is not
       enough room to display the entire selector in a single row, it will collapse into a
       dropdown configuration based on the
-      :meth:`RangeSelector.dropdown <highcharts_stock.options.range_selector.RangeSelector.dropdown>`
+      :meth:`RangeSelector.dropdown <highcharts_gantt.options.range_selector.RangeSelector.dropdown>`
       setting.
 
     .. seealso::
 
-      * :class:`RangeSelector <highcharts_stock.options.range_selector.RangeSelector>`
-      * :meth:`HighchartsStockOptions.range_selector <highcharts_stock.options.HighchartsStockOptions.range_selector>`
+      * :class:`RangeSelector <highcharts_gantt.options.range_selector.RangeSelector>`
+      * :meth:`HighchartsGanttOptions.range_selector <highcharts_gantt.options.HighchartsGanttOptions.range_selector>`
+      * :meth:`HighchartsStockOptions.range_selector <highcharts_gantt.options.HighchartsStockOptions.range_selector>`

docs/using/_importing.rst

@@ -1,14 +1,14 @@
   .. note::
 
-    ``.add_series()`` is supported by both the
-    :class:`Chart <highcharts_stock.chart.Chart>` and
-    :class:`HighchartsStockOptions <highcharts_stock.options.HighchartsStockOptions>`
+    ``.add_series()`` is supported by the
+    :class:`Chart <highcharts_gantt.chart.Chart>`,
+    :class:`HighchartsGanttOptions <highcharts_gantt.options.HighchartsGanttOptions>`, and
+    :class:`HighchartsStockOptions <highcharts_gantt.options.HighchartsStockOptions>`
     classes
 
 .. code-block:: python
 
   my_chart = Chart()
-  my_chart.add_series(my_series1, my_series2)
 
   my_series = LineSeries()
   my_chart.add_series(my_series)
@@ -19,12 +19,12 @@
     :noindex:
 
     Adds ``series`` to the
-    :meth:`Chart.options.series <highcharts_stock.options.HighchartsStockOptions.series>`
+    :meth:`Chart.options.series <highcharts_gantt.options.HighchartsGanttOptions.series>`
     property.
 
     :param series: One or more :term:`series` instances (descended from
-      :class:`SeriesBase <highcharts_stock.options.series.base.SeriesBase>`) or an
+      :class:`SeriesBase <highcharts_gantt.options.series.base.SeriesBase>`) or an
       instance (e.g. :class:`dict <python:dict>`, :class:`str <python:str>`, etc.)
       coercable to one
-    :type series: :class:`SeriesBase <highcharts_stock.options.series.base.SeriesBase>`
+    :type series: :class:`SeriesBase <highcharts_gantt.options.series.base.SeriesBase>`
       or coercable

docs/using/_working_with_stock_features.rst

@@ -1,8 +1,9 @@
   .. note::
 
-    ``.from_series()`` is supported by both the
-    :class:`Chart <highcharts_stock.chart.Chart>` and
-    :class:`HighchartsStockOptions <highcharts_stock.options.HighchartsStockOptions>`
+    ``.from_series()`` is supported by the
+    :class:`Chart <highcharts_gantt.chart.Chart>`,
+    :class:`HighchartsGanttOptions <highcharts_gantt.options.HighchartsGanttOptions>`, and
+    :class:`HighchartsStockOptions <highcharts_gantt.options.HighchartsStockOptions>`
     classes
 
 .. code-block:: python
@@ -17,14 +18,14 @@
   .. method:: .from_series(cls, *series, kwargs = None)
     :noindex:
 
-    Creates a new :class:`Chart <highcharts_stock.chart.Chart>` instance populated
+    Creates a new :class:`Chart <highcharts_gantt.chart.Chart>` instance populated
     with ``series``.
 
     :param series: One or more :term:`series` instances (descended from
-      :class:`SeriesBase <highcharts_stock.options.series.base.SeriesBase>`) or an
+      :class:`SeriesBase <highcharts_gantt.options.series.base.SeriesBase>`) or an
       instance (e.g. :class:`dict <python:dict>`, :class:`str <python:str>`, etc.)
       coercable to one
-    :type series: :class:`SeriesBase <highcharts_stock.options.series.base.SeriesBase>`
+    :type series: :class:`SeriesBase <highcharts_gantt.options.series.base.SeriesBase>`
       or coercable
 
     :param kwargs: Other properties to use as keyword arguments for the instance to be
@@ -33,10 +34,10 @@
       .. warning::
 
         If ``kwargs`` sets the
-        :meth:`options.series <highcharts_stock.options.HighchartsStockOptions.series>`
+        :meth:`options.series <highcharts_gantt.options.HighchartsGanttOptions.series>`
         property, that setting will be *overridden* by the contents of ``series``.
 
     :type kwargs: :class:`dict <python:dict>`
 
-    :returns: A new :class:`Chart <highcharts_stock.chart.Chart>` instance
-    :rtype: :class:`Chart <highcharts_stock.chart.Chart>`
+    :returns: A new :class:`Chart <highcharts_gantt.chart.Chart>` instance
+    :rtype: :class:`Chart <highcharts_gantt.chart.Chart>`

docs/using/assembling_your_chart/_using_add_series.rst

@@ -1,8 +1,8 @@
 .. code-block:: python
 
-  from highcharts_stock.chart import Chart
-  from highcharts_stock.options.series.area import LineSeries
-  from highcharts_stock.options.series.bar import BarSeries
+  from highcharts_gantt.chart import Chart
+  from highcharts_gantt.options.series.area import LineSeries
+  from highcharts_gantt.options.series.bar import BarSeries
 
   # Create a Chart instance called "my_chart" with an empty set of options
   my_chart = Chart(options = {})

docs/using/assembling_your_chart/_using_from_series.rst

@@ -1,19 +1,19 @@
 .. code-block:: python
 
-  from highcharts_stock.chart import Chart
-  from highcharts_stock.options.series.area import LineSeries
-  from highcharts_stock.headless_export import ExportServer
+  from highcharts_gantt.chart import Chart
+  from highcharts_gantt.options.series.gantt import GanttSeries
+  from highcharts_gantt.headless_export import ExportServer
 
   custom_server = ExportServer(url = 'https://www.mydomain.dev/some_pathname_goes_here')
 
   my_chart = Chart(container = 'target_div',
                    options = {
                        'series': [
-                           LineSeries(data = [0, 5, 3, 5])
+                           GanttSeries(data = [ ... ])
                        ]
                    },
                    variable_name = 'myChart',
-                   is_stock_chart = True)
+                   is_gantt_chart = True)
 
   # Download a PNG version of the chart in memory within your Python code.
   my_png_image = my_chart.download_chart(format = 'png',
@@ -33,14 +33,14 @@
   If you are using a custom :term:`export server`, it is strongly recommended that you
   supply its configuration (e.g. the URL) via environment variables. For more information,
   please see
-  :class:`headless_export.ExportServer <highcharts_stock.headless_export.ExportServer>`.
+  :class:`headless_export.ExportServer <highcharts_gantt.headless_export.ExportServer>`.
 
 .. collapse:: Method Signature
 
   .. seealso::
 
-    * :meth:`Chart.download_chart() <highcharts_stock.chart.Chart.download_chart>`
-    * :class:`headless_export.ExportServer <highcharts_stock.headless_export.ExportServer>`
+    * :meth:`Chart.download_chart() <highcharts_gantt.chart.Chart.download_chart>`
+    * :class:`headless_export.ExportServer <highcharts_gantt.headless_export.ExportServer>`
 
   .. method:: .download_chart(self, filename = None, format = 'png', server_instance = None, scale = 1, width = None, auth_user = None, auth_password = None, timeout = 0.5, global_options = None, **kwargs)
     :noindex:
@@ -112,8 +112,8 @@
       ``Highcharts.setOptions()`` method, and which will be applied to the exported
       chart. Defaults to :obj:`None <python:None>`.
 
-    :type global_options: :class:`HighchartsStockOptions <highcharts_stock.options.HighchartsStockOptions>`,
-      :class:`HighchartsOptions <highcharts_stock.options.HighchartsOptions>` or
+    :type global_options: :class:`HighchartsStockOptions <highcharts_gantt.options.HighchartsStockOptions>`,
+      :class:`HighchartsOptions <highcharts_gantt.options.HighchartsOptions>` or
       :obj:`None <python:None>`
 
     .. note::

docs/using/assembling_your_chart/_using_series_property.rst

@@ -1,16 +1,16 @@
 .. code-block:: python
 
-  from highcharts_stock.chart import Chart
-  from highcharts_stock.options.series.area import LineSeries
+  from highcharts_gantt.chart import Chart
+  from highcharts_gantt.options.series.gantt import GanttSeries
 
   my_chart = Chart(container = 'target_div',
                    options = {
                        'series': [
-                           LineSeries(data = [0, 5, 3, 5])
+                           GanttSeries(data = [ ... ])
                        ]
                    },
                    variable_name = 'myChart',
-                   is_stock_chart = True)
+                   is_gantt_chart = True)
 
   # Download a PNG version of the chart in memory within your Python code.
   my_png_image = my_chart.download_chart(format = 'png')
@@ -25,8 +25,8 @@
 
   .. seealso::
 
-    * :meth:`Chart.download_chart() <highcharts_stock.chart.Chart.download_chart>`
-    * :class:`headless_export.ExportServer <highcharts_stock.headless_export.ExportServer>`
+    * :meth:`Chart.download_chart() <highcharts_gantt.chart.Chart.download_chart>`
+    * :class:`headless_export.ExportServer <highcharts_gantt.headless_export.ExportServer>`
 
   .. method:: .download_chart(self, filename = None, format = 'png', server_instance = None, scale = 1, width = None, auth_user = None, auth_password = None, timeout = 0.5, global_options = None, **kwargs)
     :noindex:
@@ -98,8 +98,8 @@
       ``Highcharts.setOptions()`` method, and which will be applied to the exported
       chart. Defaults to :obj:`None <python:None>`.
 
-    :type global_options: :class:`HighchartsStockOptions <highcharts_stock.options.HighchartsStockOptions>`,
-      :class:`HighchartsOptions <highcharts_stock.options.HighchartsOptions>` or
+    :type global_options: :class:`HighchartsStockOptions <highcharts_gantt.options.HighchartsStockOptions>`,
+      :class:`HighchartsOptions <highcharts_gantt.options.HighchartsOptions>` or
       :obj:`None <python:None>`
 
     .. note::

docs/using/download_visualizations/_using_custom.rst

@@ -5,8 +5,8 @@
     .. note::
 
       All standard :term:`series` (descending from
-      :class:`SeriesBase <highcharts_stock.options.series.base.SeriesBase>`) have an
-      :meth:`.add_indicator() <highcharts_stock.options.series.base.SeriesBase>` method
+      :class:`SeriesBase <highcharts_gantt.options.series.base.SeriesBase>`) have an
+      :meth:`.add_indicator() <highcharts_gantt.options.series.base.SeriesBase>` method
       which can be used to easily configure a new indicator tied to the series in
       question.
 
@@ -29,7 +29,7 @@
 
         :param chart: The chart object in which the series is rendered and to which the
           indicator should be appended.
-        :type chart: :class:`Chart <highcharts_stock.chart.Chart>`
+        :type chart: :class:`Chart <highcharts_gantt.chart.Chart>`
 
         :param indicator_name: The name of the indicator that should be added to the series
           and chart. For the list of supported indicators, please review the
@@ -42,7 +42,7 @@
 
         :returns: ``chart`` with a new indicator series included in its list of configured
           series.
-        :rtype: :class:`Chart <highcharts_stock.chart.Chart>`
+        :rtype: :class:`Chart <highcharts_gantt.chart.Chart>`
 
   .. tab:: Using ``Chart.add_indicator()``
 
@@ -73,20 +73,20 @@
         Creates a :class:`IndicatorSeriesBase` (descendant) that calculates the
         ``indicator_name`` :term:`technical indicator` for the series provided in
         ``series``, and adds it to the chart's
-        :meth:`.options.series <highcharts_stock.options.HighchartsStockOptions.series>`.
+        :meth:`.options.series <highcharts_gantt.options.HighchartsStockOptions.series>`.
 
         :param indicator_name: The name of the indicator that should be added to the series
           and chart. For the list of supported indicators, please review the
           :ref:`Indicator List <indicator_list>`.
         :type indicator_name: :class:`str <python:str>`
 
         :param series: The series to which the indicator should be added. Accepts either a
-          series' :meth:`.id <highcharts_stock.options.series.SeriesBase.id>` as a
+          series' :meth:`.id <highcharts_gantt.options.series.SeriesBase.id>` as a
           :class:`str <python:str>`, or a
-          :class:`SeriesBase <highcharts_stock.options.series.base.SeriesBase>` (descendant)
+          :class:`SeriesBase <highcharts_gantt.options.series.base.SeriesBase>` (descendant)
           instance.
         :type series: :class:`str <python:str>` or
-          :class:`SeriesBase <highcharts_stock.options.series.base.SeriesBase>`
+          :class:`SeriesBase <highcharts_gantt.options.series.base.SeriesBase>`
 
         :param indicator_kwargs: Keyword arguments to apply when instantiating the new
           indicator series. Defaults to :obj:`None <python:None>`.