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

[CI] Use Ray fork of pytest-sphinx #35927

Merged
merged 6 commits into from
Jun 1, 2023
Merged

Conversation

bveeramani
Copy link
Member

Why are these changes needed?

pytest-sphinx lacks:

  • Support for MyST files
  • The ability to mock outputs for illustrative purposes

To address these issues, I've forked pytest-sphinx to https://github.com/ray-project/pytest-sphinx and implemented the features.

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
@can-anyscale
Copy link
Collaborator

I assume we don't want to maintain pytest-sphinx. Do we have plan to merge these features to the main pytest-sphinx sometimes soon?

@bveeramani
Copy link
Member Author

I assume we don't want to maintain pytest-sphinx. Do we have plan to merge these features to the main pytest-sphinx sometimes soon?

Yeah, I have a PR open: twmr/pytest-sphinx#54.

Also, the changes are minor (see ray-project/pytest-sphinx#1 and ray-project/pytest-sphinx#2), so the maintenance burden is low anyway.

@can-anyscale
Copy link
Collaborator

Sound good, can we add a TODO or an issue somewhere to follow up and move back to the original pytest-sphinx.

Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
@bveeramani bveeramani marked this pull request as draft June 1, 2023 03:58
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
@bveeramani bveeramani marked this pull request as ready for review June 1, 2023 04:12
@amogkam amogkam merged commit 8d11931 into ray-project:master Jun 1, 2023
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
pytest-sphinx lacks:

Support for MyST files
The ability to mock outputs for illustrative purposes
To address these issues, I've forked pytest-sphinx to https://github.com/ray-project/pytest-sphinx and implemented the features.

---------

Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
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.

5 participants