Skip to content
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

Jump to bottom

ReST rendering improved #3519

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ReST rendering improved #3519

wants to merge 1 commit into from

Conversation

happz
Copy link
Collaborator

@happz happz commented Feb 10, 2025 •
edited
Loading

Basically sneaking CLI themes in. The patch brings better and cleaner
rendering of various ReST features, simplified code thanks to the use of
SkipChildren, and while I was working on that, I connected the dots
and let tmt configuration dictate colors for these ReST directives.

The main benefit as of now is better rendering of help texts on command
line. I hope to provide documentation - we do not seem to have any place
for it yet - with examples, and start using the rendering for hints and
tmt about.

Pull Request Checklist

  • implement the feature
  • write the documentation
  • extend the test coverage
  • update the specification
  • adjust plugin docstring
  • modify the json schema
  • mention the version
  • include a release note

@happz happz added this to the 1.44 milestone Feb 10, 2025
@happz happz force-pushed the rest-way-improved branch from 3e61771 to 2668554 Compare February 10, 2025 16:22
@happz happz added the ci | full test Pull request is ready for the full test execution label Feb 10, 2025
@happz happz force-pushed the rest-way-improved branch 2 times, most recently from 238e183 to b9892cf Compare February 12, 2025 22:48
@happz happz force-pushed the rest-way-improved branch 2 times, most recently from c325e9b to 5da8be8 Compare March 5, 2025 18:22
@happz happz mentioned this pull request Mar 11, 2025
Merged
3 tasks
@happz happz force-pushed the rest-way-improved branch from 5da8be8 to c28c19b Compare March 11, 2025 08:25
@happz happz marked this pull request as ready for review March 11, 2025 08:25
@happz happz force-pushed the rest-way-improved branch from c28c19b to a39a2a2 Compare March 11, 2025 08:28
@mcasquer mcasquer removed this from the 1.44 milestone Mar 11, 2025
@psss psss added the status | backlog Defined, prioritized, we plan to work on it. label Mar 11, 2025
@mcasquer mcasquer added the priority | should medium priority, should be included in the next release label Mar 11, 2025
@mcasquer
Copy link
Collaborator

This fixes an ugly duplicated word in #3311

@happz happz force-pushed the rest-way-improved branch from a39a2a2 to f972e62 Compare March 12, 2025 09:30
@psss psss removed the status | backlog Defined, prioritized, we plan to work on it. label Mar 13, 2025
@psss psss added this to the 1.45 milestone Mar 13, 2025
@happz happz added the status | blocking other work An important pull request, blocking other pull requests or issues label Mar 13, 2025
@happz happz force-pushed the rest-way-improved branch from f972e62 to b43fba5 Compare March 14, 2025 18:21
skycastlelily
skycastlelily reviewed Mar 17, 2025
View reviewed changes
skycastlelily
skycastlelily approved these changes Mar 17, 2025
View reviewed changes
Copy link
Collaborator

@skycastlelily skycastlelily left a comment

Choose a reason for hiding this comment

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

Otherwise,LGTM, plus my mr kind of depends on this mr due to the _parse_config_subtree added here^^

@happz happz force-pushed the rest-way-improved branch from b43fba5 to 05108fb Compare March 18, 2025 17:58
therazix
therazix approved these changes Mar 19, 2025
View reviewed changes
Copy link
Collaborator

@therazix therazix left a comment

Choose a reason for hiding this comment

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

LGTM. Just one question.

@happz
Copy link
Collaborator Author

happz commented Mar 19, 2025

Adding blocked label - I'd like to add some documentation for the new configuration of the change, but I do not know where to put it.

@psss @lukaszachy @thrix any ideas? It does not seem to me we have any existing docs for ~/.config/tmt.

@happz happz added the status | blocked The merging of PR is blocked on some other issue label Mar 19, 2025
@happz happz force-pushed the rest-way-improved branch from cdcab71 to 0b7e948 Compare March 19, 2025 11:34
@happz happz mentioned this pull request Mar 20, 2025
Open
8 tasks
@happz
Copy link
Collaborator Author

happz commented Mar 20, 2025

Dropping blocked, I'm getting no responses and there seems to be no place for configuration documentation. Once this and #2967 get merged, we can tackle the "document tmt configuration keys" in one patch.

@happz happz added status | ready for merge The only missing piece is to do the rebase the current 'main' and let the CI finish. and removed status | blocked The merging of PR is blocked on some other issue labels Mar 20, 2025
@happz
ReST rendering improved
1567437 
Basically sneaking CLI themes in. The patch brings better and cleaner
rendering of various ReST features, simplified code thanks to the use of
`SkipChildren`, and while I was working on that, I connected the dots
and let tmt configuration dictate colors for these ReST directives.

The main benefit as of now is better rendering of help texts on command
line. I hope to provide documentation - we do not seem to have any place
for it yet - with examples, and start using the rendering for hints and
`tmt about`.
@happz happz force-pushed the rest-way-improved branch from 0b7e948 to 1567437 Compare March 20, 2025 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skycastlelily skycastlelily skycastlelily approved these changes

@therazix therazix therazix approved these changes

@psss psss Awaiting requested review from psss psss is a code owner

@lukaszachy lukaszachy Awaiting requested review from lukaszachy lukaszachy is a code owner

@thrix thrix Awaiting requested review from thrix thrix is a code owner

@janhavlin janhavlin Awaiting requested review from janhavlin janhavlin is a code owner

@martinhoyer martinhoyer Awaiting requested review from martinhoyer martinhoyer is a code owner

Assignees
No one assigned
Labels
ci | full test Pull request is ready for the full test execution priority | should medium priority, should be included in the next release status | blocking other work An important pull request, blocking other pull requests or issues status | ready for merge The only missing piece is to do the rebase the current 'main' and let the CI finish.
Projects
None yet
Milestone
1.45
Development

Successfully merging this pull request may close these issues.
5 participants
@happz @mcasquer @skycastlelily @therazix @psss