Skip to content

chore: update sphinx-terminal requirement from ~=1.0 to ~=1.1 - #2678

Open
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/uv/sphinx-terminal-approx-eq-1.1
Open

chore: update sphinx-terminal requirement from ~=1.0 to ~=1.1#2678
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/uv/sphinx-terminal-approx-eq-1.1

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Aug 1, 2026

Copy link
Copy Markdown
Contributor

Updates the requirements on sphinx-terminal to permit the latest version.

Release notes

Sourced from sphinx-terminal's releases.

sphinx-terminal 1.1.0

16 July 2026

These release notes cover new features and fixes in the sphinx-terminal extension. For the full diff, check out the commit log.

What's new in 1.1.0

prompt option

In previous versions of sphinx-terminal, the terminal prompt was customized with the user, host, and dir options and would be formatted as a Bash-style prompt. In addition to these options, sphinx-terminal 1.1.0 introduces a more flexible prompt option that allows you to declare the entire prompt. This makes the source more concise and, more importantly, allows you to document interactions in other shells.

For example, if you wanted to document a PowerShell command, you'd add something like:

.. terminal::
    :prompt: PS C:\Users\JJ>
Write-Output 'Hello, world!'

Hello, world!

Which renders as:

The user, host, and dir options are still available in sphinx-terminal 1.1.0 but are incompatible with the prompt option. If both are declared in the same directive, an error is thrown.

Styling for consecutive terminals

When multiple terminal directives are included in succession, they're now merged into a single terminal block. This is useful for documenting longer interactions where the individual commands don't warrant much explanation.

For example, if you added the following directives to your doc:

.. terminal::
echo 'hello'

hello

.. terminal::

echo 'goodbye'

goodbye

They'd render as:

... (truncated)

Commits
  • c2d344e fix: whitespace for scrollable terminals
  • cf61705 feat: add a more flexible 'prompt' option (#72)
  • de4aa52 chore(deps): update zizmorcore/zizmor-action action to v0.6.0 (#73)
  • c885f9a fix: allow empty input lines (#70)
  • cb5aa0b fix: make input respect 'scroll' option (#71)
  • b927ff3 Merge pull request #69 from canonical/work/copy-tooltip/21
  • f5aa522 fix: lint target
  • f5ace7d fix: hide CSS-only tooltip
  • f8e2017 Merge pull request #68 from canonical/work/stacked-terminals/32
  • cd62bfc feat: merge consecutive terminals
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [sphinx-terminal](https://github.com/canonical/sphinx-terminal) to permit the latest version.
- [Release notes](https://github.com/canonical/sphinx-terminal/releases)
- [Commits](canonical/sphinx-terminal@1.0.0...1.1.0)

---
updated-dependencies:
- dependency-name: sphinx-terminal
  dependency-version: 1.1.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot Bot added the dependencies Issue/PR created by dependabot label Aug 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Issue/PR created by dependabot

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants