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

Run sphinx-lint against friend projects. #47

Closed
wants to merge 2 commits into from

Conversation

ezio-melotti
Copy link
Collaborator

I noticed that the workflow downloads "friend projects" but doesn't seem to run sphinx-lint against them -- only pytest. However, it appears that none of those repos/dirs have any docs-related tests (or any tests at all), so nothing is done with that.

I'm assuming the intention was to run sphinx-lint against them, so I'm opening this draft PR to see what happens.

@ezio-melotti
Copy link
Collaborator Author

I just noticed that [download-more-tests.sh](https://github.com/sphinx-contrib/sphinx-lint/blob/main/download-more-tests.sh) was just added recently, so it might still be a work-in-progress 🙃.

The last commit seem to pass though, but I'm going to double check if there is any issue. (cc @JulienPalard)

@ezio-melotti
Copy link
Collaborator Author

I tried locally and verified that the projects are cloned correctly and none of them have any error. Passing --enable=default-role results in several errors, proving that the command works correctly.

@ezio-melotti ezio-melotti marked this pull request as ready for review October 6, 2022 19:03
@ezio-melotti
Copy link
Collaborator Author

#46 revealed several failures that only happen when --enable=default-role is passed, that are not currently exposed by this PR.
The tests should probably use the same commands used in each of those repos.

@JulienPalard
Copy link
Collaborator

pytest run tests against friend projects here:

def test_sphinxlint_friend_projects_shall_pass(file, capsys):

I did it like this because the first version was downloading friends projects under fixtures/xpass/ so no lines of code was needed to test them. But it was a pain to see them in git status :D

@JulienPalard
Copy link
Collaborator

I added documentation in download-more-tests.sh and a docstring in test_friends.py.

@ezio-melotti ezio-melotti deleted the patch-1 branch October 7, 2022 02:25
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.

2 participants