feat(docs): add tabs and group tabs to improve documentation examples#1395
feat(docs): add tabs and group tabs to improve documentation examples#1395dzhalaevd wants to merge 3 commits intopytest-dev:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
seifertm
left a comment
There was a problem hiding this comment.
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?
| @@ -0,0 +1 @@ | |||
| Added ``sphinx-tabs`` to organize documentation examples into tabs. | |||
There was a problem hiding this comment.
Rather than mentioning this in the added category (as in "added features"), we should add this to the downstream category to notify downstream packagers of the added dependency.
| @@ -0,0 +1 @@ | |||
| Added ``sphinx-tabs`` to organize documentation examples into tabs. | |||
There was a problem hiding this comment.
| Added ``sphinx-tabs`` to organize documentation examples into tabs. | |
| Added dependency on ``sphinx-tabs >= 3.5`` to organize documentation examples into tabs. |
What was wrong?
Users of pytest-asyncio can only pick
autoorstrictmode per project, but the docs show examples for both. Is kinda confusing, so we need add tabsCloses: #641
Related: #641
How it was fixed?