Revert "delete content directory (#159)"

This reverts commit 24b289d.

Author: clyne

content/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+live:
+	sphinx-autobuild --ignore _build -b dirhtml  . _build/dirhtml/
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

content/_ext/nb_gallery_generator.py

@@ -0,0 +1,169 @@
+"""
+Sphinx plugin to run generate a gallery for notebooks
+"""
+import base64
+import dataclasses
+import json
+import os
+import pathlib
+import random
+import shutil
+from textwrap import dedent
+
+import matplotlib.image
+import matplotlib.pyplot as plt
+import pandas as pd
+import yaml
+
+with open('lorem_ipsum.txt') as fid:
+    descriptions = fid.read().split('\n\n')
+
+
+DOC_SRC = pathlib.Path(os.path.dirname(os.path.abspath(__file__))).parent
+default_img_loc = DOC_SRC / '_static/images/sphinx-logo.png'
+thumbnail_dir = DOC_SRC / '_static/thumbnails'
+thumbnail_dir.mkdir(parents=True, exist_ok=True)
+
+
+def create_thumbnail(infile, width=275, height=275, cx=0.5, cy=0.5, border=4):
+    """Overwrites `infile` with a new file of the given size"""
+    im = matplotlib.image.imread(infile)
+    rows, cols = im.shape[:2]
+    size = min(rows, cols)
+    if size == cols:
+        xslice = slice(0, size)
+        ymin = min(max(0, int(cx * rows - size // 2)), rows - size)
+        yslice = slice(ymin, ymin + size)
+    else:
+        yslice = slice(0, size)
+        xmin = min(max(0, int(cx * cols - size // 2)), cols - size)
+        xslice = slice(xmin, xmin + size)
+    thumb = im[yslice, xslice]
+    thumb[:border, :, :3] = thumb[-border:, :, :3] = 0
+    thumb[:, :border, :3] = thumb[:, -border:, :3] = 0
+
+    dpi = 100
+    fig = plt.figure(figsize=(width / dpi, height / dpi), dpi=dpi)
+
+    ax = fig.add_axes([0, 0, 1, 1], aspect='auto', frameon=False, xticks=[], yticks=[])
+    ax.imshow(thumb, aspect='auto', resample=True, interpolation='bilinear')
+    fig.savefig(infile, dpi=dpi)
+    plt.close(fig)
+    return fig
+
+
+@dataclasses.dataclass
+class NotebookInfo:
+    filepath: pathlib.Path
+    default_img_loc: pathlib.Path
+    thumbnail_dir: pathlib.Path
+    src_dir: pathlib.Path
+
+    def __post_init__(self):
+        self.thumbnail_dir.mkdir(parents=True, exist_ok=True)
+        self.png_path = self.thumbnail_dir / f'{self.filepath.stem}.png'
+        with open(self.filepath) as fid:
+            self.json_source = json.load(fid)
+            self.gen_preview()
+
+        nb_id = f'{self.filepath.relative_to(self.src_dir).parent}/{self.filepath.stem}'
+        self.info = {
+            'thumbnail': f'../{self.png_path.relative_to(self.src_dir).as_posix()}',
+            'notebook': f'../{self.filepath.relative_to(self.src_dir).as_posix()}',
+            'title': self.extract_title(),
+            'url': f'../{nb_id}.html',
+            'id': nb_id,
+            'description': random.choice(descriptions)[:200].strip(),
+        }
+
+    def gen_preview(self):
+        preview = self.extract_preview_pic()
+        if preview is not None:
+            with open(self.png_path, 'wb') as buff:
+                buff.write(preview)
+        else:
+            shutil.copy(self.default_img_loc, self.png_path)
+
+        create_thumbnail(self.png_path)
+
+    def extract_preview_pic(self):
+        """Use the last image in the notebook as preview pic"""
+        pic = None
+        for cell in self.json_source['cells']:
+            for output in cell.get('outputs', []):
+                if 'image/png' in output.get('data', []):
+                    pic = output['data']['image/png']
+        if pic is not None:
+            return base64.b64decode(pic)
+        return None
+
+    def extract_title(self):
+        for cell in self.json_source['cells']:
+            if cell['cell_type'] == 'markdown':
+                rows = [row.strip() for row in cell['source'] if row.strip()]
+                for row in rows:
+                    if row.startswith('# '):
+                        return row[2:].replace(':', '-')
+        return self.filepath.stem.replace('_', ' ').replace(':', '-')
+
+
+def build_gallery(srcdir, gallery, contains_notebooks):
+    src_dir = pathlib.Path(srcdir)
+    os.chdir(srcdir)
+    target_dir = src_dir / f'{gallery}_gallery'
+    image_dir = target_dir / '_thumbnails'
+    image_dir.mkdir(parents=True, exist_ok=True)
+
+    if contains_notebooks:
+        notebooks_path = src_dir / 'notebooks'
+        notebooks = sorted(
+            [notebook for notebook in notebooks_path.glob('**/*.ipynb') if 'checkpoint' not in notebook.name]
+        )
+        entries = [
+            NotebookInfo(note, default_img_loc=default_img_loc, thumbnail_dir=image_dir, src_dir=src_dir).info
+            for note in notebooks
+        ]
+        df = pd.DataFrame(entries).sort_values(by=['title'])
+        entries = df.to_dict(orient='records')
+        with open(target_dir / f'{gallery}_gallery.yaml', 'w') as fid:
+            yaml.dump(entries, fid)
+
+        panels_body = []
+        for entry in entries:
+            x = f"""\
+            ---
+            :img-top: {entry["thumbnail"]}
+            +++
+            **{entry['title']}**
+
+            {entry['description'][:50]} ...
+
+            {{link-badge}}`{entry["url"]},"rendered-notebook",cls=badge-secondary text-white float-left p-2 mr-1`
+            """
+
+            panels_body.append(x)
+
+        panels_body = '\n'.join(panels_body)
+
+        gallery_content = f'''# {gallery.capitalize()} Gallery
+````{{panels}}
+:container: full-width
+:column: text-left col-6 col-lg-4
+:card: +my-2
+:img-top-cls: w-75 m-auto p-2
+:body: d-none
+
+{dedent(panels_body)}
+````
+'''
+        with open(target_dir / 'index.md', 'w') as fid:
+            fid.write(dedent(gallery_content))
+
+
+def main(app):
+    for gallery in [('notebooks', True)]:
+        build_gallery(app.builder.srcdir, gallery[0], gallery[1])
+
+
+def setup(app):
+    app.connect('builder-inited', main)

content/_ext/yaml_gallery_generator.py

@@ -0,0 +1,174 @@
+import itertools
+import pathlib
+from textwrap import dedent
+
+import yaml
+
+
+def _tag_in_item(item, tag_str=None):
+    if tag_str is None:
+        return True
+    all_tags = sorted(itertools.chain(*item['tags'].values()))
+    return tag_str in all_tags
+
+
+def _generate_sorted_tag_keys(all_items):
+
+    key_set = set(itertools.chain(*[item['tags'].keys() for item in all_items]))
+    return sorted(key_set)
+
+
+def _generate_tag_set(all_items, tag_key=None):
+
+    tag_set = set()
+    for item in all_items:
+        for k, e in item['tags'].items():
+            if tag_key and k != tag_key:
+                continue
+            for t in e:
+                tag_set.add(t)
+
+    return tag_set
+
+
+def _generate_tag_menu(all_items, tag_key):
+
+    tag_set = _generate_tag_set(all_items, tag_key)
+    tag_list = sorted(tag_set)
+
+    hrefs = ''.join(
+        f'<a class="dropdown-item" href="/pages/links/{tag.replace(" ", "-")}.html">{tag.title()}</a> \n'
+        for tag in tag_list
+    )
+
+    return f"""
+<div class="dropdown">
+<button class="btn btn-sm btn-primary m-2 dropdown-toggle" data-toggle="collapse" data-target="#{tag_key}" aria-haspopup="true">{tag_key.title()}</button>
+<div id="{tag_key}" class="collapse dropdown-menu">
+{hrefs}
+</div>
+</div>
+"""
+
+
+def _generate_menu(all_items, flt=None):
+
+    key_list = _generate_sorted_tag_keys(all_items)
+    menu_html = '<div class="d-flex flex-row"> \n'
+    for tag_key in key_list:
+        menu_html += _generate_tag_menu(all_items, tag_key) + '\n'
+    if flt:
+        menu_html += '<a type="button" class="btn btn-link" href="/pages/links.html">Return to Full Gallery</a> \n'
+    menu_html += '<a type="button" class="btn btn-link" style="position:absolute; right:0;" href="https://github.com/ProjectPythia/projectpythia.github.io/issues/new?assignees=&labels=external-links-gallery-submission&template=update-external-links-gallery.md&title=">Submit a Link</a> \n'
+    menu_html += '</div> \n'
+    menu_html += '<script> $(document).on("click",function(){$(".collapse").collapse("hide");}); </script> \n'
+    return menu_html
+
+
+def build_from_items(items, filename, display_name, menu_html):
+
+    # Build the gallery file
+    panels_body = []
+    for item in items:
+        if not item.get('thumbnail'):
+            item['thumbnail'] = '/_static/images/ebp-logo.png'
+        thumbnail = item['thumbnail']
+        tag_list = sorted((itertools.chain(*item['tags'].values())))
+        tags = [
+            f'{{link-badge}}`"/pages/links/{tag.replace(" ", "-")}.html",{tag},cls=badge-primary badge-pill text-light`'
+            for tag in tag_list
+        ]
+        tags = '\n'.join(tags)
+
+        authors = [a.get('name', 'anonymous') for a in item['authors']]
+        authors_str = f"Created by: {', '.join(authors)}"
+
+        email = [a.get('email') for a in item['authors']][0]
+        email_str = '' if email is None else f'Email: {email}'
+
+        affiliation = [a.get('affiliation') for a in item['authors']][0]
+        affiliation_str = '' if affiliation is None else f'Affiliation: {affiliation}'
+
+        affiliation_url = [a.get('affiliation_url') for a in item['authors']][0]
+        affiliation_url_str = '' if affiliation_url is None else f'{affiliation} Site: <{affiliation_url}>'
+
+        panels_body.append(
+            f"""\
+---
+:img-top: {thumbnail}
++++
+**{item["title"]}**
+
+<button class="modal-btn">See Details</button>
+<div class="modal">
+  <div class="content">
+<p>
+<img src={thumbnail} />
+
+**{item["title"]}**
+
+{authors_str}
+
+{email_str}
+
+{affiliation_str}
+
+{affiliation_url_str}
+
+{item['description']}
+
+```{{link-button}} {item["url"]}
+:type: url
+:text: Visit Website
+:classes: btn-outline-primary btn-block
+```
+
+{tags}
+</p>
+  </div>
+</div>
+
+{tags}
+"""
+        )
+
+    panels_body = '\n'.join(panels_body)
+
+    panels = f"""
+# {display_name}
+
+{menu_html}
+
+````{{panels}}
+:column: text-left col-6 col-lg-4
+:card: +my-2
+:img-top-cls: w-75 m-auto p-2
+:body: d-none
+
+{dedent(panels_body)}
+````
+<div class="backdrop"></div>
+<script src="/_static/custom.js"> </script>
+"""
+
+    pathlib.Path(f'pages/{filename}.md').write_text(panels)
+
+
+def main(app):
+
+    with open('links.yaml') as fid:
+        all_items = yaml.safe_load(fid)
+
+    menu_html = _generate_menu(all_items)
+    build_from_items(all_items, 'links', 'External Links Gallery', menu_html)
+
+    menu_html_flt = _generate_menu(all_items, flt=True)
+    tag_set = _generate_tag_set(all_items)
+
+    for tag in tag_set:
+        items = [item for item in all_items if _tag_in_item(item, tag)]
+        build_from_items(items, f'links/{tag.replace(" ", "-")}', f'External Links Gallery - "{tag}"', menu_html_flt)
+
+
+def setup(app):
+    app.connect('builder-inited', main)