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.

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

Document custom Jinja template filters #2769

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Document custom Jinja template filters #2769

merged 1 commit into from
Apr 23, 2024

Conversation

happz
Copy link
Collaborator

@happz happz commented Mar 18, 2024

Pull Request Checklist

  • implement the feature
  • write the documentation

@happz happz added documentation Improvements or additions to documentation code | no functional change "No Functional Change" intended. Patch should not change tmt's behavior in any way. labels Mar 18, 2024
@happz happz added this to the 1.33 milestone Mar 18, 2024
@thrix
Copy link
Collaborator

thrix commented Mar 19, 2024

/packit test

@psss psss changed the title Document custom Jinja emplate filters Document custom Jinja template filters Mar 26, 2024
@happz happz force-pushed the docs-template-filters branch 3 times, most recently from 2115536 to 2bded11 Compare April 2, 2024 11:29
@happz happz requested a review from martinhoyer as a code owner April 2, 2024 11:29
@martinhoyer
Copy link
Collaborator

Is Overview the right place for it? Looking at dictionary, overview = "a general explanation or description of something".

fwiw, I still think the man page should be dropped :)
On the other hand, how about adding tldr entry?

@happz
Copy link
Collaborator Author

happz commented Apr 3, 2024

Is Overview the right place for it? Looking at dictionary, overview = "a general explanation or description of something".

It's not the right place, and trying to sneak it there was a stupid idea from the beginning. Now it's under Code, https://tmt--2769.org.readthedocs.build/en/2769/code/template-filters.html

@happz happz added the ci | full test Pull request is ready for the full test execution label Apr 10, 2024
Copy link
Collaborator

@psss psss left a comment

Choose a reason for hiding this comment

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

Nice improvement, thanks! Just two nitpicks.

docs/code/index.rst Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Includes a small refactoring of man page building to overcome rst2man
handling of `:ref:` directives.
@psss psss merged commit d211b9c into main Apr 23, 2024
14 of 20 checks passed
@psss psss deleted the docs-template-filters branch April 23, 2024 08:00
@psss psss self-assigned this Apr 23, 2024
The-Mule pushed a commit to The-Mule/tmt that referenced this pull request Oct 14, 2024
Includes a small refactoring of man page building to overcome rst2man
handling of `:ref:` directives.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci | full test Pull request is ready for the full test execution code | no functional change "No Functional Change" intended. Patch should not change tmt's behavior in any way. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants