Skip to content

feat(docs): add tabs and group tabs to improve documentation examples#1395

Merged
seifertm merged 4 commits intopytest-dev:mainfrom
dzhalaevd:641-doc-mode-switch
Apr 7, 2026
Merged

feat(docs): add tabs and group tabs to improve documentation examples#1395
seifertm merged 4 commits intopytest-dev:mainfrom
dzhalaevd:641-doc-mode-switch

Conversation

@dzhalaevd
Copy link
Copy Markdown
Contributor

What was wrong?

Users of pytest-asyncio can only pick auto or strict mode per project, but the docs show examples for both. Is kinda confusing, so we need add tabs

Closes: #641
Related: #641

How it was fixed?

  • Add sphinx-tabs deps
  • Update some doc files

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.13%. Comparing base (6a53907) to head (aa306b1).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1395   +/-   ##
=======================================
  Coverage   95.13%   95.13%           
=======================================
  Files           2        2           
  Lines         473      473           
  Branches       57       57           
=======================================
  Hits          450      450           
  Misses         17       17           
  Partials        6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@seifertm seifertm left a comment

Choose a reason for hiding this comment

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

Thank you @dzhalaevd ! It will require reviewing the pytest-asyncio documentation to make use of this, but the sphinx-tab integration itself is valuable already.

Can you move the news fragment to the correct category as mentioned in the comment?

- change news fragment to the correct category
- add more context in news fragment

Co-authored-by: Michael Seifert <m.seifert@digitalernachschub.de>
@dzhalaevd dzhalaevd force-pushed the 641-doc-mode-switch branch from 8ba7f4b to aa306b1 Compare April 6, 2026 21:38
Copy link
Copy Markdown
Contributor

@seifertm seifertm left a comment

Choose a reason for hiding this comment

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

Thanks!

@seifertm seifertm added this pull request to the merge queue Apr 7, 2026
Merged via the queue into pytest-dev:main with commit df9239b Apr 7, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow switching doc examples between auto and strict mode

3 participants