Skip to content

Add plugin hooks to RTD documentation #415

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Dec 13, 2020
Merged

Add plugin hooks to RTD documentation #415

merged 5 commits into from
Dec 13, 2020

Conversation

@gnikonorov
Copy link
Member

@gnikonorov gnikonorov commented Dec 13, 2020 •
edited
Loading

This PR adds information on the plugin hooks to our read the docs documentation.

@gnikonorov gnikonorov added docs This issue/PR relates to or includes documentation. skip-changelog Can be missed from the changelog. labels Dec 13, 2020
@gnikonorov gnikonorov self-assigned this Dec 13, 2020
@gnikonorov gnikonorov marked this pull request as draft December 13, 2020 05:39
@gnikonorov
Copy link
Member Author

gnikonorov commented Dec 13, 2020

Sorry for any email spam. This should be good for review/merge @ssbarnea / @BeyondEvil

@gnikonorov gnikonorov marked this pull request as ready for review December 13, 2020 06:18
@gnikonorov
Copy link
Member Author

gnikonorov commented Dec 13, 2020

Bump for a review/merge @BeyondEvil and/or @ssbarnea

BeyondEvil
BeyondEvil approved these changes Dec 13, 2020
View reviewed changes
Copy link
Contributor

@BeyondEvil BeyondEvil left a comment

Choose a reason for hiding this comment

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

Approved with one hopeful ugh 😏

docs/conf.py
import os
import sys

sys.path.insert(0, os.path.abspath("../src/"))
Copy link
Contributor

@BeyondEvil BeyondEvil Dec 13, 2020

Choose a reason for hiding this comment

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

ugh... isn't there a better way?

Maybe setting the PYTHONPATH env var?

Copy link
Member Author

@gnikonorov gnikonorov Dec 13, 2020

Choose a reason for hiding this comment

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

I'm not entirely sure @BeyondEvil. I made that change as per https://github.com/pytest-dev/pytest-html/blob/master/docs/conf.py#L7 and also some results on the internet. It seems like this is the preferred way to go about doing this

Copy link
Contributor

@BeyondEvil BeyondEvil Dec 13, 2020

Choose a reason for hiding this comment

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

Fair enough @gnikonorov

Copy link
Member Author

@gnikonorov gnikonorov Dec 13, 2020

Choose a reason for hiding this comment

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

Are you ok with me merging this in then @BeyondEvil?

Copy link
Contributor

@BeyondEvil BeyondEvil Dec 13, 2020

Choose a reason for hiding this comment

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

Well sure, on one condition. If you, once it's rebased and updated, approve the flaky windows PR. 😛 @gnikonorov

@gnikonorov gnikonorov merged commit 51a982c into pytest-dev:master Dec 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BeyondEvil BeyondEvil BeyondEvil approved these changes

@ssbarnea ssbarnea Awaiting requested review from ssbarnea

Assignees

@gnikonorov gnikonorov

Labels

docs This issue/PR relates to or includes documentation. skip-changelog Can be missed from the changelog.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@gnikonorov @BeyondEvil