Merge pull request #53 from jnywong/hub-activity

Add hub activity to current community partners page

Author: jnywong

.github/workflows/deploy_website.yml

@@ -34,15 +34,22 @@ jobs:
       run: |
         pip install -r requirements.txt
 
+
     # (optional) Cache your executed notebooks between runs
     # if you have config:
-    # execute:
-    #   execute_notebooks: cache
-    # - name: cache executed notebooks
-    #   uses: actions/cache@v3
-    #   with:
-    #     path: _build/.jupyter_cache
-    #     key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
+    execute:
+      execute_notebooks: cache
+    - name: cache executed notebooks
+      uses: actions/cache@v3
+      with:
+        path: _build/.jupyter_cache
+        key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
+
+    # Update git submodules
+    - name: Update git submodules
+      run: |
+        git pull --recurse-submodules
+        git submodule update --remote --recursive
 
     # Build the book
     - name: Build the book

.gitignore

@@ -1,2 +1,3 @@
 _build
-.ipynb_checkpoints
+.ipynb_checkpoints
+.env

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "catalystbook/hub-activity"]
+	path = catalystbook/hub-activity
+	url = https://github.com/czi-catalystproject/hub-activity.git

.readthedocs.yml

@@ -2,6 +2,9 @@
 # ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
 version: 2
 
+submodules:
+  include: all
+  recursive: true
 build:
   os: ubuntu-22.04
   tools:
@@ -10,6 +13,7 @@ build:
   commands:
     - pip install -r requirements.txt
     - jupyter-book build catalystbook/
+    - cat /home/docs/checkouts/readthedocs.org/user_builds/catalyst-website/checkouts/53/catalystbook/_build/html/reports/hub-activity/hub-activity.err.log
     - mkdir -p $READTHEDOCS_OUTPUT/html/
     - cp -r catalystbook/_build/html/* $READTHEDOCS_OUTPUT/html/
 

catalystbook/_config.yml

@@ -8,11 +8,12 @@ logo: images/catalyst-logo/catalyst-logo-dark-bg-white.png
 copyright: '2024'
 description: >-
    This is The Catalyst Project brochure website, built with JupyterBook. 
+# Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")
+exclude_patterns            : [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints", hub-activity/README.md]
 
-# Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
 execute:
-  execute_notebooks: force
+  execute_notebooks: auto
 
 # Define the name of the latex output file for PDF builds
 latex:
@@ -70,15 +71,21 @@ parse:
 
 # Localisation
 sphinx:
-#   extra_extensions:
+  extra_extensions:
+  - myst_nb
 #   - sphinx_inline_tabs
   config:
     language: en
     html_show_copyright: false
     html_last_updated_fmt: '%b %d, %Y'
+    html_js_files:
+    - https://cdn.plot.ly/plotly-2.31.1.min.js #  NOTE: load plotly before require
+    - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
+    suppress_warnings: ["mystnb.unknown_mime_type"]
     nb_render_priority:
       gettext: {}
     locale_dirs: ['locale/']
     gettext_compact: false
     gettext_additional_targets: ['literal-block']
     gettext_location: false
+    

catalystbook/current-community-partners.md

@@ -1,3 +1,17 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+    format_version: 0.13
+    jupytext_version: 1.16.1
+kernelspec:
+  display_name: Python 3 (ipykernel)
+  language: python
+  name: python3
+---
+
 # Current community partners
 
 During the initial phase the Catalyst Project aims to work with 10 community partners in Africa and a further 10 in Latin America. You can find the currently active community partners listed below. Where websites are available these are linked from each partner’s logo.
@@ -120,3 +134,7 @@ Medellín, Colombia
 :::
 
 ::::
+
+```{raw} html
+:file: hub-activity/activity.html
+```

catalystbook/hub-activity

@@ -4,7 +4,8 @@ pandas
 matplotlib
 pyyaml
 requests
-jupyter-book
+jupyter-book>=1.0.0
+jupytext
 sphinx
 sphinx-autobuild
 sphinx-copybutton