Reference docs#3193
Merged
Merged
Conversation
Member
Author
|
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). 👍 |
Member
|
+1000 |
Member
|
The approach seems fine as well, this would be a great addition. |
Member
Author
|
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
Member
Author
|
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. 👍 |
Member
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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)inioptionspytest_plugins, ...)