Skip to content

Details about sphinx-terminal #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Details about sphinx-terminal #447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0fd8289
Details about sphinx-terminal
msuchane Oct 9, 2025
e0be7dd
GitHub readme link
msuchane Oct 10, 2025
1071f15
GitHub readme link
msuchane Oct 10, 2025
84dcf44
Better wording
msuchane Oct 10, 2025
91bb26d
Better wording
msuchane Oct 10, 2025
06b5c1d
Describe the terminal copy button
msuchane Oct 13, 2025
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
13 changes: 11 additions & 2 deletions docs/reference/myst-syntax-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,17 @@ 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 make the terminal scroll horizontally instead of wrapping long lines, add `:scroll:`.
To customize the prompt (`user@host:~$` by default), specify any of the following options:

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

To add a button that copies the command specified in `:input:`, include the `:copy:` option.

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

For more details, refer to the [`sphinx-terminal` README](https://github.com/canonical/sphinx-terminal/blob/main/README.md).

## Links

Expand Down
13 changes: 11 additions & 2 deletions docs/reference/rst-syntax-reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,17 @@ 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 make the terminal scroll horizontally instead of wrapping long lines, add ``:scroll:``.
To customize the prompt (``user@host:~$`` by default), specify any of the following options:

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

To add a button that copies the command specified in ``:input:``, include the ``:copy:`` option.

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

For more details, refer to the `sphinx-terminal README <https://github.com/canonical/sphinx-terminal/blob/main/README.md>`_.

Links
-----
Expand Down
Loading