-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Reference docs #3193
Reference docs #3193
Conversation
Guys, just to be clear, while this is marked as WIP I still would like a quick review of the approach and a "go ahead" signal (or not). 👍 |
+1000 |
The approach seems fine as well, this would be a great addition. |
Thanks @flub for the feedback. I worked a little more on this today. |
This gets out of sync and shows internal plugins which don't make much sense
Internal links should be displayed in the side-bar
This adds some more capabilities to sphinx, like marking functions as decorators or with contexts
Otherwise they are recognized as iterators
OK I think this is ready to be merged. 😅 This was much more work than I expected TBH. The reference docs are not perfect, but I think they are a step in the right direction, we can improve them over the course of more iterations in the future. I plan to merge this in the next few days unless someone wants more time to take a look, in which case just leave a comment please. 👍 |
This is an initial work to have a "Reference" page destined for users already familiar with pytest but want to quickly see the signature of an object or how to use a fixture.
Some notes:
What are your thoughts and should I continue working on this?Since I got a +1000, I've continued this effort.Review link: https://docs.pytest.org/en/ref-docs/reference.html
TODO
Item
,Module
, etc)pytest.fail
,pytest.skip
, etc)Command-line options(I've decided to leave this out for now)ini
optionspytest_plugins
, ...)