Skip to content

Commit

Permalink
add copybutton sphinx extension
Browse files Browse the repository at this point in the history
  • Loading branch information
elliotfontaine committed Jul 22, 2024
1 parent d3a5d86 commit c127997
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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):
Expand Down
14 changes: 7 additions & 7 deletions docs/source/user_guide/workflow_control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,36 +15,36 @@ 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
========

:doc:`Cylc TUI <cylc:7-to-8/major-changes/ui>` 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
========
Expand Down

0 comments on commit c127997

Please sign in to comment.