Skip to content

Move documentation to read the docs #402

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

Merged
merged 8 commits into from
Dec 9, 2020

Conversation

gnikonorov
Copy link
Member

@gnikonorov gnikonorov commented Dec 7, 2020

This PR moves our documentation from rst files in the project root to read the docs.

The docs are located at https://pytest-html.readthedocs.io/en/latest/. Note that nothing is found yet since docs build upon merge to master, and we have not yet built any docs. I built them locally and things looked fine.

If you want to see the generated documentation as part of your review, you can check out this branch and run tox -e docs. Then run a webserver from docs/_build/html.

I intentionally kept the documentation as similar to the current documentation as possible to reduce the scope of this PR.

NOTE: I'll remove the existing documentation once this merges and properly builds, since I don't want to delete the documentation until I'm confident this works as expected.

NOTE: This needs to take #400 into account if it merges before this PR is in

@gnikonorov gnikonorov added the docs This issue/PR relates to or includes documentation. label Dec 7, 2020
@gnikonorov gnikonorov self-assigned this Dec 7, 2020
@gnikonorov gnikonorov added the enhancement This issue/PR relates to a feature request. label Dec 7, 2020
@gnikonorov
Copy link
Member Author

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

@ssbarnea
Copy link
Member

ssbarnea commented Dec 8, 2020

@gnikonorov Please add me (ssbarnea) on RTD, so I can configure the repo too. I want to enable RTD app too, as RTD can also build PRs and make them available so user can browse the docsite build with their own changes.

@gnikonorov
Copy link
Member Author

@gnikonorov Please add me (ssbarnea) on RTD, so I can configure the repo too. I want to enable RTD app too, as RTD can also build PRs and make them available so user can browse the docsite build with their own changes.

Of course @ssbarnea I'll add you tonight. @BeyondEvil are you on RTD?

@gnikonorov
Copy link
Member Author

@ssbarnea I added you as a maintainer on readthedocs.

Note this PR is intentionally onlly setting up the documentation, since I wanted to keep scope as small as possible. I have some follow ups planned once this PR merges

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.

Wow, this all looks great! This is new territory for me as I've never set something like this up before!

If you don't mind, as a comment (preferably in the OP), could you describe for each file (related to RTD) explain what is going on?

If @ssbarnea has more experience with RTD I'd be great if he could review this.

@BeyondEvil
Copy link
Contributor

@BeyondEvil are you on RTD?

I don't think so. I'll create an account.

@ssbarnea ssbarnea closed this Dec 9, 2020
@ssbarnea ssbarnea reopened this Dec 9, 2020
@ssbarnea ssbarnea closed this Dec 9, 2020
@ssbarnea ssbarnea reopened this Dec 9, 2020
@ssbarnea
Copy link
Member

ssbarnea commented Dec 9, 2020

@gnikonorov As you can see I managed to enable RTD to build PRs. If it succeeds it should produce browsable site. We should also keep our own tox build of the docs as this assures that local building also works.

But from the review point of view of docs changes, we should look at the RTD job and evaluated if the change works or not as intended.

@gnikonorov
Copy link
Member Author

@ssbarnea it looks good to me.

Can we please merge this in sooner rather than later if we're happy? It's breaking open PRs since the project is trying to build docs that don't exist (#393 for example)

@ssbarnea ssbarnea merged commit 817d04d into pytest-dev:master Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue/PR relates to or includes documentation. enhancement This issue/PR relates to a feature request.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants