Skip to content

Conversation

@msuchane
Copy link
Contributor

@msuchane msuchane commented Oct 9, 2025

Some useful options for the sphinx-terminal extension were missing. I've added one (:dir:) and linked the upstream documentation for the rest.

Copy link
Collaborator

@minaelee minaelee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Failing linkcheck tests due to malformed URLs, see suggestions. Ty!

@minaelee
Copy link
Collaborator

minaelee commented Oct 9, 2025

Requesting review from @jahn-junior also because he has been working on terminal extension updates recently, maybe there's something to be noted here.

@minaelee minaelee requested a review from jahn-junior October 9, 2025 17:18
@jahn-junior
Copy link
Contributor

Thanks for doing this! I've found that a handful of the terminal directive's options are unknown to most of the team. It looks like you've got a good handle on this, but feel free to reach out if you have any questions. 👍

@msuchane
Copy link
Contributor Author

I think this should now be ready to merge. I've applied all suggestions.

Copy link
Contributor

@jahn-junior jahn-junior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@AnneCYH AnneCYH requested a review from minaelee October 21, 2025 07:43
Copy link
Collaborator

@minaelee minaelee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Marek!

In general, I think we need to flag all custom Canonical Sphinx directives as such (explicitly mentioning they are not a part of MyST or rST standard syntax), including any information about versions and options (such as the copy option), but this can be a part of the starter pack docs updates epic next cycle rather than holding up this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants