docs not explicit about render env

[zachvalenta]

If one runs the code from the docs intro from the REPL:

from great_tables import GT, md, html
from great_tables.data import islands

islands_mini = islands.head(10)

# Create a display table showing ten of the largest islands in the world
gt_tbl = GT(islands_mini)
# Show the output table
gt_tbl

it produces...not a great table:

If run as a script:

python great-tables-intro.py

it produces...nothing:

seems like the intro, in order to just work™️, should be updated to:

• produce something that can be rendered

from great_tables import GT, md, html
from great_tables.data import islands

islands_mini = islands.head(10)
gt_tbl = GT(islands_mini)
GT.write_raw_html(
    gt_tbl,
    'tbl.html',
    encoding='utf-8',
    newline=None,
    make_page=False,
    all_important=False,
)

• specify how to render i.e. "open the HTML file in the browser"

[rich-iannone]

Thanks for raising this. The trick here is to call the show() method on gt_tbl (which then should open the default browser and display the table in a new page). We mention this in the README but not in the Get Started guide. So, I think there should be a callout there.

I'll also try to reproduce the script-running method (with show()) to see if that works.