temp_profile and html layout fix attempts

aiidalab_widgets_base/utils/__init__.py

@@ -210,3 +210,25 @@ def ase2spglib(ase_structure: Atoms) -> Tuple[Any, Any, Any]:
     numbers = ase_structure.get_atomic_numbers()
 
     return (lattice, positions, numbers)
+
+
+# Load the temp profile for notebooks on readthedocs
+def load_temp_profile():
+    """Load the temp profile to make sure the docs build succeed even if the current
+    default profile of the AiiDA installation is not configured.
+    """
+    from aiida import load_profile
+    from aiida.manage.configuration import get_config
+    from aiida.storage.sqlite_temp import SqliteTempBackend
+
+    profile = load_profile(
+        SqliteTempBackend.create_profile(
+            "readthedocs",
+            options={"warnings.development_version": False, "runner.poll.interval": 1},
+            debug=False,
+        ),
+        allow_switch=True,
+    )
+    config = get_config()
+    config.add_profile(profile)
+    config.set_default_profile(profile.name)

aiidalab_widgets_base/viewers.py

@@ -109,15 +109,15 @@ def __init__(self, parameter, downloadable=True, **kwargs):
         </style>
         """
 
-        pd.set_option("max_colwidth", 40)
+        pd.set_option("max_colwidth", 100)
         dataf = pd.DataFrame(
             [(key, value) for key, value in sorted(parameter.get_dict().items())],
             columns=["Key", "Value"],
         )
-        self.value += dataf.to_html(
-            classes="df", index=False
-        )  # specify that exported table belongs to 'df' class
+        # specify that exported table belongs to 'df' class
         # this is used to setup table's appearance using CSS
+        # `colwidths-auto` and `table` are also required for proper table rendering in MyST: https://myst-parser.readthedocs.io/en/latest/syntax/tables.html
+        self.value += dataf.to_html(classes="df colwidths-auto table", index=False)
         if downloadable:
             payload = base64.b64encode(dataf.to_csv(index=False).encode()).decode()
             fname = f"{parameter.pk}.csv"

docs/source/conf.py

@@ -8,11 +8,31 @@
 import time
 from pathlib import Path
 
-# Load the dummy profile to make sure the docs build succeed even if the current
-# default profile of the AiiDA installation is not configured.
-from aiida.manage.configuration import load_documentation_profile
 
-load_documentation_profile()
+# Load the temp profile to make sure the docs build succeed even if the current
+# default profile of the AiiDA installation is not configured.
+def load_temp_profile():
+    """Load the temp profile to make sure the docs build succeed even if the current
+    default profile of the AiiDA installation is not configured.
+    """
+    from aiida import load_profile
+    from aiida.manage.configuration import get_config
+    from aiida.storage.sqlite_temp import SqliteTempBackend
+
+    profile = load_profile(
+        SqliteTempBackend.create_profile(
+            "readthedocs",
+            options={"warnings.development_version": False, "runner.poll.interval": 1},
+            debug=False,
+        ),
+        allow_switch=True,
+    )
+    config = get_config()
+    config.add_profile(profile)
+    config.set_default_profile(profile.name)
+
+
+load_temp_profile()
 
 from aiidalab_widgets_base import __version__  # pylint: disable=wrong-import-position
 

notebooks/computational_resources.ipynb

@@ -28,9 +28,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from aiida import load_profile\n",
+    "from aiidalab_widgets_base.utils import load_temp_profile\n",
     "\n",
-    "load_profile();"
+    "load_temp_profile()"
    ]
   },
   {

notebooks/eln_configure.ipynb

@@ -30,9 +30,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from aiida import load_profile\n",
+    "from aiidalab_widgets_base.utils import load_temp_profile\n",
     "\n",
-    "load_profile();"
+    "load_temp_profile()"
    ]
   },
   {

notebooks/eln_import.ipynb

@@ -30,9 +30,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from aiida import load_profile\n",
+    "from aiidalab_widgets_base.utils import load_temp_profile\n",
     "\n",
-    "load_profile();"
+    "load_temp_profile()"
    ]
   },
   {

notebooks/process.ipynb

@@ -26,9 +26,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from aiida import load_profile\n",
+    "from aiidalab_widgets_base.utils import load_temp_profile\n",
     "\n",
-    "load_profile();"
+    "load_temp_profile()"
    ]
   },
   {

notebooks/process_list.ipynb

@@ -26,9 +26,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from aiida import load_profile\n",
+    "from aiidalab_widgets_base.utils import load_temp_profile\n",
     "\n",
-    "load_profile();"
+    "load_temp_profile()"
    ]
   },
   {

notebooks/structures.ipynb

@@ -26,9 +26,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from aiida import load_profile\n",
+    "from aiidalab_widgets_base.utils import load_temp_profile\n",
     "\n",
-    "load_profile();"
+    "load_temp_profile()"
    ]
   },
   {
@@ -90,7 +90,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.13"
+   "version": "3.9.15"
   }
  },
  "nbformat": 4,

notebooks/viewers.ipynb

@@ -8,9 +8,10 @@
    "source": [
     "# default profile of the AiiDA installation is not configured.\n",
     "from aiida import orm\n",
-    "from aiida.manage.configuration import load_documentation_profile\n",
     "\n",
-    "load_documentation_profile()"
+    "from aiidalab_widgets_base.utils import load_temp_profile\n",
+    "\n",
+    "load_temp_profile()"
    ]
   },
   {

notebooks/wizard_apps.ipynb

@@ -17,11 +17,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Load the dummy profile to make sure the docs build succeed even if the current\n",
-    "# default profile of the AiiDA installation is not configured.\n",
-    "from aiida.manage.configuration import load_documentation_profile\n",
+    "from aiidalab_widgets_base.utils import load_temp_profile\n",
     "\n",
-    "load_documentation_profile()"
+    "load_temp_profile()"
    ]
   },
   {