Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/reference/myst-syntax-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,16 @@ To show a terminal view, use the following directive:
Input is specified as the `:input:` option (or prefixed with `:input:` as part of the main content of the directive).
Output is the main content of the directive.

To override the prompt (`user@host:~$` by default), specify the `:user:` and/or `:host:` options.
To override the prompt (`user@host:~$` by default), specify any of the following options:

* `:user:`
* `:host:`
* `:dir:`

To make the terminal scroll horizontally instead of wrapping long lines, add `:scroll:`.

For details, see the [`sphinx-terminal` documentation](https://pypi.org/project/sphinx-terminal/#description>).

## Links

How to link depends on if you are linking to an external URL or to another page in the documentation.
Expand Down
9 changes: 8 additions & 1 deletion docs/reference/rst-syntax-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,9 +173,16 @@ To include a terminal view, use the following directive:
Input is specified as the ``:input:`` option (or prefixed with ``:input:`` as part of the main content of the directive).
Output is the main content of the directive.

To override the prompt (``user@host:~$`` by default), specify the ``:user:`` and/or ``:host:`` options.
To override the prompt (``user@host:~$`` by default), specify any of the following options:

* ``:user:``
* ``:host:``
* ``:dir:``

To make the terminal scroll horizontally instead of wrapping long lines, add ``:scroll:``.

For details, see the `sphinx-terminal documentation <https://pypi.org/project/sphinx-terminal/#description>`_.

Links
-----

Expand Down
Loading