Skip to content

Commit f2cb81d

Browse files
Add what to expect section in landing page
Fix nbsphinx syntax highlighting for code cell
1 parent 994c745 commit f2cb81d

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed
202 KB
Loading

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,8 @@
7272
# Allow build to continue even if some notebooks error (useful for demos).
7373
nbsphinx_allow_errors = True
7474

75+
# Ensure Pygments syntax highlighting for Jupyter code cells.
76+
nbsphinx_codecell_lexer = 'ipython'
77+
7578
# Remove the .txt suffix that gets added to source files
7679
html_sourcelink_suffix = ''

docs/index.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,40 @@ with details about the server location, and how to use the instance
2828
to upload and display astronomical images, tables and charts.
2929

3030

31+
What to expect
32+
==============
33+
34+
.. raw:: html
35+
36+
<div style="margin-bottom: 1.15rem;">
37+
38+
.. image:: _static/firefly-in-python-flow.png
39+
:alt: Firefly in Python Flow Diagram
40+
:align: center
41+
42+
.. raw:: html
43+
44+
</div>
45+
46+
It's important to note that Firefly visualization in Python notebooks is
47+
**NOT a per-cell chart or widget**, unlike common plotting libraries
48+
such as Plotly or Bokeh.
49+
50+
Under the hood, Firefly is a dedicated web application running at a specific
51+
URL, rather than a plot produced as a notebook cell output.
52+
Your notebook's Python session connects to a Firefly server, either a publicly
53+
hosted instance (such as the `IRSA Viewer`_) or a local server running via Docker_.
54+
Using a server enables advanced, compute-intensive interactivity that is
55+
difficult to support directly within a notebook's UI.
56+
57+
Multiple notebook cells can then send commands to the same Firefly instance,
58+
which manages linked views of images, charts, and tables, similar to an
59+
**interactive dashboard**.
60+
61+
.. _IRSA Viewer: https://irsa.ipac.caltech.edu/irsaviewer/
62+
.. _Docker: https://hub.docker.com/r/ipac/firefly
63+
64+
3165
.. _firefly_client-using:
3266

3367
Using firefly_client

0 commit comments

Comments
 (0)