[CI] Migrate from sphinx.ext.doctest to pytest-sphinx
#35286
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 5984f1e.
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>
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>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
This reverts commit de05655. 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>
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>
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>
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>
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
commented
May 26, 2023
| @@ -85,7 +85,7 @@ def train_loop_per_worker(): | |||
|
|
|||
| Example: | |||
|
|
|||
| .. code-block:: python | |||
| .. testcode:: | |||
There was a problem hiding this comment.
We need at least one GPU test, or else Bazel fails and complains that no tests were found.
bveeramani
commented
May 26, 2023
bveeramani
commented
May 26, 2023
| @@ -61,6 +61,29 @@ | |||
| # these tests in n different jobs. | |||
|
|
|||
| load("//bazel:python.bzl", "py_test_module_list") | |||
| load("//bazel:python.bzl", "doctest") | |||
|
|
|||
| # TODO(@bveeramani): Enable doctests. | |||
There was a problem hiding this comment.
RLLib has many failing doctests. Since it'll take a while to address those, I'd like to enable doctests for RLLib in a follow-up PR.
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
avnishn
approved these changes
May 26, 2023
richardliaw
approved these changes
May 26, 2023
amogkam
approved these changes
May 27, 2023
jjyao
approved these changes
May 27, 2023
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
fishbone
approved these changes
May 27, 2023
bveeramani
added
the
tests-ok
krfricke
approved these changes
May 30, 2023
|
nice work! |
This was referenced May 30, 2023
Merged
ericl
pushed a commit
that referenced
this pull request
May 31, 2023
#35286 broke CI. These issues weren't caught earlier because the PR was out of date with master.
amogkam
pushed a commit
that referenced
this pull request
Jun 9, 2023
#35286 temporarily disabled doctests for RLLib because there are many broken and (previously) untested docstring examples. This PR re-enables them. --------- Signed-off-by: Balaji Veeramani <balaji@anyscale.com> Signed-off-by: Artur Niederfahrenhorst <attaismyname@googlemail.com> Co-authored-by: Artur Niederfahrenhorst <attaismyname@googlemail.com>
scv119
pushed a commit
to scv119/ray
that referenced
this pull request
Jun 16, 2023
…t#35286) This PR switches our doctest tooling from sphinx.ext.doctest to pytest-sphinx. Context We want to test all code snippets in CI. testcode and doctest examples are tested in CI with sphinx.ext.doctest. But, we often write code-block:: python examples, and they aren't tested in CI. Problem sphinx.ext.doctest doesn't let you test specific files. As a result, it's hard to update examples or isolate GPU examples. Solution Migrate to pytest-sphinx. Two reasons: Lets us run GPU doctests Enables developers to quickly test their examples --------- Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
scv119
pushed a commit
to scv119/ray
that referenced
this pull request
Jun 16, 2023
ray-project#35286 broke CI. These issues weren't caught earlier because the PR was out of date with master.
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
…t#35286) This PR switches our doctest tooling from sphinx.ext.doctest to pytest-sphinx. Context We want to test all code snippets in CI. testcode and doctest examples are tested in CI with sphinx.ext.doctest. But, we often write code-block:: python examples, and they aren't tested in CI. Problem sphinx.ext.doctest doesn't let you test specific files. As a result, it's hard to update examples or isolate GPU examples. Solution Migrate to pytest-sphinx. Two reasons: Lets us run GPU doctests Enables developers to quickly test their examples --------- Signed-off-by: Balaji Veeramani <balaji@anyscale.com> Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
ray-project#35286 broke CI. These issues weren't caught earlier because the PR was out of date with master. Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
ray-project#35286 temporarily disabled doctests for RLLib because there are many broken and (previously) untested docstring examples. This PR re-enables them. --------- Signed-off-by: Balaji Veeramani <balaji@anyscale.com> Signed-off-by: Artur Niederfahrenhorst <attaismyname@googlemail.com> Co-authored-by: Artur Niederfahrenhorst <attaismyname@googlemail.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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Stacked on:
log_oncedocstring #35807TorchDetectionPredictortype hint and docstring #35829Why are these changes needed?
This PR switches our doctest tooling from sphinx.ext.doctest to pytest-sphinx.
Context
We want to test all code snippets in CI.
testcodeand doctest examples are tested in CI withsphinx.ext.doctest. But, we often writecode-block:: pythonexamples, and they aren't tested in CI.Problem
sphinx.ext.doctestdoesn't let you test specific files. As a result, it's hard to update examples or isolate GPU examples.Solution
Migrate to
pytest-sphinx. Two reasons:Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.