Add copy button selector to docs (nextflow-io#5663)

Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Chris Hakkaart <[email protected]>
Co-authored-by: Ben Sherman <[email protected]>
Signed-off-by: Jonathan Manning <[email protected]>

Author: 2 people

docs/conf.py

@@ -35,7 +35,8 @@
   'sphinxext.rediraffe',
   'sphinx_rtd_theme',
   'myst_parser',
-  'sphinx_tabs.tabs'
+  'sphinx_tabs.tabs',
+  'sphinx_copybutton'
 ]
 
 myst_enable_extensions = ['colon_fence', 'deflist', 'dollarmath']
@@ -130,6 +131,8 @@
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
+# Add copyable selector
+copybutton_selector = ".copyable pre"
 
 # -- Options for HTML output ---------------------------------------------------
 

docs/install.md

@@ -8,7 +8,8 @@
 
 Nextflow can be used on any POSIX-compatible system (Linux, macOS, etc), and on Windows through [WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux). It requires Bash 3.2 (or later) and [Java 17 (or later, up to 23)](http://www.oracle.com/technetwork/java/javase/downloads/index.html) to be installed. You can see which version you have using the following command:
 
-```bash
+```{code-block} bash
+:class: copyable
 java -version
 ```
 
@@ -22,21 +23,24 @@ To install Java with SDKMAN:
 
 1. [Install SDKMAN](https://sdkman.io/install):
 
-    ```bash
+    ```{code-block} bash
+    :class: copyable
     curl -s https://get.sdkman.io | bash
     ```
 
 2. Open a new terminal.
 
 3. Install Java:
 
-    ```bash
+    ```{code-block} bash
+    :class: copyable
     sdk install java 17.0.10-tem
     ```
 
 4. Confirm that Java is installed correctly:
 
-    ```bash
+    ```{code-block} bash
+    :class: copyable
     java -version
     ```
 
@@ -48,25 +52,28 @@ Nextflow is distributed as a self-installing package, in order to make the insta
 
 1. Install Nextflow:
 
-    ```bash
+    ```{code-block} bash
+    :class: copyable
     curl -s https://get.nextflow.io | bash
     ```
 
     This will create the `nextflow` executable in the current directory.
 
     :::{tip}
-    You can set `export CAPSULE_LOG=none` to make the installation logs less verbose.
+    Set `export CAPSULE_LOG=none` to make the installation logs less verbose.
     :::
 
 2. Make Nextflow executable:
 
-    ```bash
+    ```{code-block} bash
+    :class: copyable
     chmod +x nextflow
     ```
 
 3. Move Nextflow into an executable path. For example:
 
-    ```bash
+    ```{code-block} bash
+    :class: copyable
     mkdir -p $HOME/.local/bin/
     mv nextflow $HOME/.local/bin/
     ```
@@ -81,21 +88,24 @@ Nextflow is distributed as a self-installing package, in order to make the insta
 
 4. Confirm that Nextflow is installed correctly:
 
-    ```bash
+    ```{code-block} bash
+    :class: copyable
     nextflow info
     ```
 
 ## Updates
 
 With Nextflow installed in your environment, you can update to the latest version using the following command:
 
-```bash
+```{code-block} bash
+:class: copyable
 nextflow self-update
 ```
 
 You can also temporarily switch to a specific version of Nextflow with the `NXF_VER` environment variable. For example:
 
-```bash
+```{code-block} bash
+:class: copyable
 NXF_VER=23.10.0 nextflow info
 ```
 
@@ -107,13 +117,15 @@ Additionally, an *edge* version is released on a monthly basis. The edge release
 
 To use the latest edge release, set `NXF_EDGE=1` when updating:
 
-```bash
+```{code-block} bash
+:class: copyable
 NXF_EDGE=1 nextflow self-update
 ```
 
 You can also use `NXF_VER` to temporarily switch to any edge release. For example:
 
-```bash
+```{code-block} bash
+:class: copyable
 NXF_VER=24.06.0-edge nextflow info
 ```
 
@@ -128,16 +140,18 @@ of the corresponding Nextflow plugins.
 
 To use the standalone distribution:
 
-1. Download it from the [GitHub releases page](https://github.com/nextflow-io/nextflow/releases), under the "Assets" section for a specific
+1. Download the standalone distribution from Assets section of the [GitHub releases page](https://github.com/nextflow-io/nextflow/releases).
 
-2. Grant execution permissions to the downloaded file e.g.
+2. Grant execution permissions to the downloaded file. For example:
 
-    ```
+    ```{code-block} bash
+    :class: copyable
     chmod -x nextflow-24.10.1-dist
     ```
 
-3. Then you can use it as a drop-in replacement for `nextflow` command. For example:
+3. Use it as a drop-in replacement for `nextflow` command. For example:
 
-    ```
+    ```{code-block} bash
+    :class: copyable
     ./nextflow-24.10.1-dist run hello
     ```

docs/requirements.txt

@@ -3,4 +3,5 @@ sphinx==5.3.0
 sphinx-rtd-theme==1.1.1
 sphinxcontrib-mermaid==0.9.2
 sphinxext-rediraffe==0.2.7
-sphinx-tabs==3.4.5
+sphinx-tabs==3.4.5
+sphinx-copybutton==0.5.2