diff --git a/docs/requirements.txt b/docs/requirements.txt index aa9b905..3373fd3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,7 @@ furo==2024.7.18 sphinx-design==0.6.0 sphinx-new-tab-link==0.5.0 +sphinx-copybutton==0.5.2 cylc-flow==8.3.0 metomi-rose==2.3.0 cylc-sphinx-extensions diff --git a/docs/source/conf.py b/docs/source/conf.py index 16f6a76..ec49c36 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,6 +39,7 @@ # community extensions "sphinx_design", "sphinx_new_tab_link", + "sphinx_copybutton", # cylc.sphinx_ext extensions (from cylc.sphinx_ext-extensions library) "cylc.sphinx_ext.cylc_lang", # Custom extensions (in ext/ directory) @@ -107,6 +108,8 @@ } new_tab_link_show_external_link_icon = True +copybutton_exclude = ".linenos, .gp, .go" +copybutton_copy_empty_lines = False def setup(app): diff --git a/docs/source/user_guide/workflow_control.rst b/docs/source/user_guide/workflow_control.rst index d4317d9..60f1315 100644 --- a/docs/source/user_guide/workflow_control.rst +++ b/docs/source/user_guide/workflow_control.rst @@ -15,21 +15,21 @@ the workflow. :figwidth: 80% :align: center - The GUI displaying a workflow using the "tree" view. @CylcDoc,2024 + :emphasis:`The GUI displaying a workflow using the "tree" view. @CylcDoc,2024` -The GUI is accessible through a web browser, and can be launched by running the ``cylc gui`` command. -This will open a new tab in your default web browser, displaying the Cylc GUI home page. +The GUI is accessible through a web browser, and can be launched by running the :command:`cylc gui` +command. This will open a new tab in your default web browser, displaying the Cylc GUI home page. It can be deployed with Jupyter Hub to support remote and multi-user access. This is useful when you want to access the workflow manager from another computer on the same network. The central server is -started by the ``cylc hub`` command. +started by the :command:`cylc hub` command. .. figure:: /_static/screenshots/cylc-hub-official.png :alt: Jupyter Hub authentication page :figwidth: 80% :align: center - The Jupyter Hub authentication page in a multi-user setup. @CylcDoc,2024 + :emphasis:`Jupyter Hub authentication page in a multi-user setup. @CylcDoc,2024` Cylc TUI ======== @@ -37,14 +37,14 @@ Cylc TUI :doc:`Cylc TUI ` is a terminal-based graphical interface that ports most of Cylc UI's features to the terminal. It provides a beginner-friendly interface when you're remotely accessing the machine running the workflow, and not exposing a Cylc Hub (JupyterHub) -instance. It requires no setup, and can be opened by running the ``cylc tui`` command. +instance. It requires no setup, and can be opened by running the :command:`cylc tui` command. .. figure:: /_static/screenshots/cylc-tui-preview-official.png :alt: Cylc terminal user interface :align: center :figwidth: 80% - Tui showing the details of a failed job. @CylcDoc,2024 + :emphasis:`The TUI showing the details of a failed job. @CylcDoc,2024` Cylc CLI ========