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

Reference docs #3193

Merged
merged 38 commits into from
Mar 15, 2018
Merged

Reference docs #3193

merged 38 commits into from
Mar 15, 2018

Conversation

nicoddemus
Copy link
Member

@nicoddemus nicoddemus commented Feb 8, 2018

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:

  • This also enables the sphinxcontrib-trio extension so we can have better representation of context managers and decorators (although the extension is named "trio", it is not specific to async or trio at all). Examples: fixture signature and capsys.disabled.
  • Exceptionally I pushed this to the official repository instead of my fork so the docs can be built automatically for easier reviewing.

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

  • Marks
  • Objects (Item, Module, etc)
  • Functions (pytest.fail, pytest.skip, etc)
  • Parametrize
  • Hooks
  • Command-line options (I've decided to leave this out for now)
  • Environment variables
  • ini options
  • Special variables (pytest_plugins, ...)

@coveralls
Copy link

coveralls commented Feb 8, 2018

Coverage Status

Coverage remained the same at 92.544% when pulling 51c0256 on ref-docs into 28df322 on master.

@nicoddemus
Copy link
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). 👍

@flub
Copy link
Member

flub commented Feb 18, 2018

+1000

@flub
Copy link
Member

flub commented Feb 18, 2018

The approach seems fine as well, this would be a great addition.

@nicoddemus
Copy link
Member Author

nicoddemus commented Feb 26, 2018

Thanks @flub for the feedback.

I worked a little more on this today.

@nicoddemus
Copy link
Member Author

nicoddemus commented Mar 12, 2018

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. 👍

@nicoddemus nicoddemus changed the title WIP: Reference docs Reference docs Mar 12, 2018
@nicoddemus
Copy link
Member Author

This fixes: #1713 and #3229

@nicoddemus nicoddemus merged commit fbcf1a9 into master Mar 15, 2018
@nicoddemus nicoddemus deleted the ref-docs branch March 15, 2018 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants