[Docs] Add BUILD_SOCIAL_CARD env, skip social card build by default (…

…#130)

.github/workflows/check_homepage_build.yaml

@@ -38,3 +38,5 @@ jobs:
         run: pip install '.[docs]'
       - name: Build homepage
         run: mkdocs build --verbose --strict
+        env:
+          BUILD_SOCIAL_CARD: true

.github/workflows/deploy_homepage.yaml

@@ -37,3 +37,5 @@ jobs:
         run: pip install '.[docs]'
       - name: Build homepage
         run: mkdocs gh-deploy --force
+        env:
+          BUILD_SOCIAL_CARD: true

mkdocs.yml

@@ -38,6 +38,7 @@ plugins:
   - search
   - autorefs
   - social:
+      enabled: !ENV [BUILD_SOCIAL_CARD, false]
       cards_dir: assets/img/social
       cards_layout_options:
         background_color: "#f7e96d"

scripts/preview_docs.sh

@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+# This script builds a local version of the documentation and makes it available at localhost:7777.
+# By default it does not build social preview cards. If you want to debug social cards,
+# set the environment variable `BUILD_SOCIAL_CARD=true` to this script.
+
 pip list | grep mkdocs-material 2>&1 >/dev/null
 
 if [[ ! $? -eq 0 ]]; then