Merge pull request #291 from boegel/eb5_from_pr_beta

mention `--from-pr` as a way to install EasyBuild v5.0.0beta1 + enable copy button in code blocks
easybuilders · Jan 9, 2025 · d189eac · d189eac
2 parents d305807 + 319c01b
commit d189eac
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 15 deletions.
diff --git a/docs/easybuild-v5/release-candidates.md b/docs/easybuild-v5/release-candidates.md
@@ -42,22 +42,27 @@ This includes (but is not limited to):
 
 To install the initial beta release of EasyBuild v5.0.0 (`5.0.0beta1`), you can either:
 
-- use the [provided easyconfig file](https://github.com/easybuilders/easybuild-easyconfigs/pull/22049);
+- use the [provided easyconfig file](https://github.com/easybuilders/easybuild-easyconfigs/pull/22049), for example using:
+
+    ```shell
+    eb --from-pr 22049
+    ```
+
 - install into a Python virtual environment:
-  
-  ```shell
-  venv_name='venv-eb-5.0.0beta1'
-  python3 -m venv ${venv_name}
-  unset PYTHONPATH
-  source ${venv_name}/bin/activate
-
-  tag='5.0.0beta1'
-  pip install https://github.com/easybuilders/easybuild-framework/archive/easybuild-framework-v${tag}.tar.gz
-  pip install https://github.com/easybuilders/easybuild-easyblocks/archive/easybuild-easyblocks-v${tag}.tar.gz
-  pip install https://github.com/easybuilders/easybuild-easyconfigs/archive/easybuild-easyconfigs-v${tag}.tar.gz
-  # optional dependencies for EasyBuild
-  pip install archspec rich
-  ```
+
+    ```shell
+    venv_name='venv-eb-5.0.0beta1'
+    python3 -m venv ${venv_name}
+    unset PYTHONPATH
+    source ${venv_name}/bin/activate
+    
+    tag='5.0.0beta1'
+    pip install https://github.com/easybuilders/easybuild-framework/archive/easybuild-framework-v${tag}.tar.gz
+    pip install https://github.com/easybuilders/easybuild-easyblocks/archive/easybuild-easyblocks-v${tag}.tar.gz
+    pip install https://github.com/easybuilders/easybuild-easyconfigs/archive/easybuild-easyconfigs-v${tag}.tar.gz
+    # optional dependencies for EasyBuild
+    pip install archspec rich
+    ```
 
 ### Planned additional changes {: #beta1_planned_changes }
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,6 +6,8 @@ theme:
   logo: img/easybuild_logo.png
   favicon: favicon.ico
   features:
+    # https://squidfunk.github.io/mkdocs-material/reference/code-blocks
+    - content.code.copy
     # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
     - navigation.instant
     - navigation.top