Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions nbsite/gallery/gen.py
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,12 @@ def convert_notebook_to_md(filename, directive='{pyodide}'):
md += f'\n{backticks}'
return md

def _gallery_item_title(name, content):
titles = content.get('titles', {})
if name in titles:
return titles[name]
return ' '.join([n[0].capitalize()+n[1:] for n in name.replace('_', ' ').split(' ')])

def generate_pyodide_markdown(
app, page, section, backend, filename, src_dir, dest_dir,
img_extension, deployed_file, deployed, skip
Expand All @@ -366,13 +372,13 @@ def generate_pyodide_markdown(
basename = os.path.basename(filename)
md_path = os.path.join(dest_dir, basename[:-len(extension)].replace(' ', '_') + 'md')
name = basename[:-(len(extension)+1)]
title = ' '.join([n[0].capitalize()+n[1:] for n in name.replace('_', ' ').split(' ')])
ftype = 'notebook' if extension == 'ipynb' else 'script'

# Unpack config
gallery_conf = app.config.nbsite_gallery_conf
examples_dir = gallery_conf['examples_dir']
content = gallery_conf['galleries'][page]
title = _gallery_item_title(name, content)

# Download link options
host = gallery_conf['host']
Expand Down Expand Up @@ -447,13 +453,13 @@ def generate_item_rst(
name = basename[:-(len(extension)+1)]
rel_path = os.path.relpath(os.path.join(src_dir, basename), dest_dir)
rst_path = os.path.join(dest_dir, basename[:-len(extension)].replace(' ', '_') + 'rst')
title = ' '.join([n[0].capitalize()+n[1:] for n in name.replace('_', ' ').split(' ')])
ftype = 'notebook' if extension == 'ipynb' else 'script'

# Unpack config
gallery_conf = app.config.nbsite_gallery_conf
examples_dir = gallery_conf['examples_dir']
content = gallery_conf['galleries'][page]
title = _gallery_item_title(name, content)
skip_execute = gallery_conf['skip_execute']

# Download link options
Expand Down
59 changes: 59 additions & 0 deletions nbsite/tests/test_gallery.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
from types import SimpleNamespace

from nbsite.gallery.gen import generate_item_rst, generate_pyodide_markdown


def _gallery_app():
gallery_conf = {
'deployment_url': None,
'download_as': None,
'examples_dir': 'examples',
'galleries': {
'panes': {
'titles': {
'Vega': 'Altair & Vega',
},
},
},
'github_org': 'holoviz',
'github_project': 'panel',
'github_ref': 'main',
'host': 'GitHub',
'iframe_spinner': '',
'jupyterlite_url': None,
'nblink': None,
'skip_execute': [],
}
return SimpleNamespace(config=SimpleNamespace(nbsite_gallery_conf=gallery_conf))


def test_generate_pyodide_markdown_uses_gallery_title(tmp_path):
source = tmp_path / 'src'
dest = tmp_path / 'dest'
source.mkdir()
dest.mkdir()
filename = source / 'Vega.py'
filename.write_text('print("vega")\n')

generate_pyodide_markdown(
_gallery_app(), 'panes', None, None, str(filename), str(source), str(dest),
'png', str(filename), False, False,
)

assert (dest / 'Vega.md').read_text().startswith('# Altair & Vega\n\n')


def test_generate_item_rst_uses_gallery_title(tmp_path):
source = tmp_path / 'src'
dest = tmp_path / 'dest'
source.mkdir()
dest.mkdir()
filename = source / 'Vega.py'
filename.write_text('print("vega")\n')

generate_item_rst(
_gallery_app(), 'panes', None, None, str(filename), str(source), str(dest),
'png', str(filename), False, False,
)

assert (dest / 'Vega.rst').read_text().startswith('Altair & Vega\n=============\n\n')