docs: fix terminal directives#2810
Open
jahn-junior wants to merge 2 commits into
Open
Conversation
jahn-junior
commented
Jul 23, 2026
Comment on lines
+111
to
+117
| .. terminal:: | ||
|
|
||
| multipass shell charm-dev | ||
| ... | ||
| ubuntu@charm-dev:~$ sudo snap install charmcraft --classic | ||
|
|
||
| .. terminal:: | ||
| :user: ubuntu | ||
| :host: charm-dev |
Contributor
Author
There was a problem hiding this comment.
These will get merged into a single terminal session once we bump the sphinx-terminal version.
6 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Stopgap documentation update to make terminal examples render correctly under the sphinx_terminal Sphinx extension, primarily by converting code-block command/output pairs into .. terminal:: blocks and marking output-only snippets.
Changes:
- Replaced several
.. code-block:: bash+.. terminal::sequences with single.. terminal::blocks that include both command and output. - Added
:output-only:to terminal blocks that show output without input. - Adjusted a few doc examples (including comment formatting in
manage-channels) as part of fixing rendering issues.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/howto/pack-a-hooks-based-charm-with-charmcraft.rst | Converts command/output examples to .. terminal:: blocks for consistent rendering. |
| docs/howto/manage-web-app-charms/use-web-app-charm.rst | Marks a terminal snippet as output-only to render as plain output. |
| docs/howto/manage-web-app-charms/configure-web-app-charm.rst | Adds an output-only terminal block for expected results. |
| docs/howto/manage-the-current-charmhub-user.rst | Converts login example to a terminal block with command + output. |
| docs/howto/manage-revisions.rst | Uses terminal blocks for command + output and marks an output-only excerpt. |
| docs/howto/manage-resources.rst | Consolidates upload examples into terminal blocks containing command + output. |
| docs/howto/manage-extensions.rst | Converts several dropdown examples to terminal blocks and adds output-only metadata. |
| docs/howto/manage-charms.rst | Updates multiple lifecycle examples in dropdowns to use terminal blocks. |
| docs/howto/manage-charmcraft.rst | Converts macOS and Multipass examples to terminal blocks (including user/host options). |
| docs/howto/manage-channels.rst | Marks channel table as output-only and changes how a hidden explanatory block is represented. |
Comments suppressed due to low confidence (2)
docs/howto/manage-extensions.rst:62
- This
.. terminal::is intended to be part of the preceding dropdown example, but it’s currently less-indented than the dropdown body, so it will be parsed outside the dropdown and may render incorrectly.
.. terminal::
docs/howto/manage-extensions.rst:112
- Within this dropdown, the
.. terminal::directive needs to be indented to the dropdown body level; otherwise it will be parsed outside the dropdown and can break the structure of the page.
.. terminal::
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note that I did not assess the quality or necessity of any of these terminal directives. This PR is only a stopgap to get everything rendering correctly until I complete CHARMCRAFT-684 next pulse.
make lint && make test.