Skip to content

Commit

Permalink
Merge pull request #94 from Carifio24/docs
Browse files Browse the repository at this point in the history
Create docs page
  • Loading branch information
Carifio24 authored Nov 12, 2024
2 parents 9e41080 + 01d828d commit cb9d8ba
Show file tree
Hide file tree
Showing 10 changed files with 3,340 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ Chart Studio
============

The Chart Studio exporter allows exporting a Qt glue session to Chart Studio, provided that all of the
viewers in the session are supported. Currently supported viewers are the matplotlib scatter, histogram,
and profile viewers.
viewers in the session are supported. Currently supported viewers are the matplotlib scatter, histogram, profile, and dendrogram viewers.

To access the exporter inside Qt glue, navigate to File > Advanced Exporters > Plotly.

Expand All @@ -61,7 +60,7 @@ Viewers
This package contains two experimental Plotly-powered viewers which can be used with glue-jupyter - a
scatter viewer and a histogram viewer. More viewers to come in the future!

`This notebook <https://github.com/glue-viz/glue-plotly/blob/main/doc/PlotlyViewerExample.ipynb>`_ demonstrates
`This notebook <https://github.com/glue-viz/glue-plotly/blob/main/docs/PlotlyViewerExample.ipynb>`_ demonstrates
basic usage of the these viewers, such as importing and viewer creation.


Expand All @@ -81,9 +80,9 @@ Package Structure
.. |Coverage Status| image:: https://codecov.io/gh/glue-viz/glue-plotly/branch/master/graph/badge.svg
:target: https://codecov.io/gh/glue-viz/glue-plotly
:alt: Glue-plotly's Coverage Status
.. |Qt toolbar demo| image:: https://raw.githubusercontent.com/glue-viz/glue-plotly/main/doc/QtToolbarExport.gif
.. |Qt toolbar demo| image:: https://raw.githubusercontent.com/glue-viz/glue-plotly/main/docs/assets/img/QtToolbarExport.gif
:alt: Qt Plotly export demo
.. |bqplot toolbar| image:: https://raw.githubusercontent.com/glue-viz/glue-plotly/main/doc/BqplotToolbarHighlighted.png
.. |bqplot toolbar| image:: https://raw.githubusercontent.com/glue-viz/glue-plotly/main/docs/assets/img/BqplotToolbarHighlighted.png
:alt: bqplot Plotly export tool
.. |Chart Studio demo| image:: https://raw.githubusercontent.com/glue-viz/glue-plotly/main/doc/QtChartStudioExport.gif
.. |Chart Studio demo| image:: https://raw.githubusercontent.com/glue-viz/glue-plotly/main/docs/assets/img/QtChartStudioExport.gif
:alt: Qt Chart Studio export demo
File renamed without changes.
Loading

0 comments on commit cb9d8ba

Please sign in to comment.