Skip to content

Commit

Permalink
[CI] Use Ray fork of pytest-sphinx (#35927)
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
bveeramani committed Jun 1, 2023
1 parent 5d803c5 commit 8d11931
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions doc/source/ray-contribute/writing-code-snippets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -301,11 +301,11 @@ How to test examples
Testing specific examples
=========================

To test specific examples, install `pytest-sphinx`.
To test specific examples, install the Ray fork of `pytest-sphinx`.

.. code-block:: bash
pip install pytest-sphinx
pip install git+https://github.com/ray-project/pytest-sphinx
Then, run pytest on a module, docstring, or user guide.

Expand Down
2 changes: 1 addition & 1 deletion python/requirements_test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ pytest-sugar==0.9.5
pytest-lazy-fixture==0.6.3
pytest-timeout==2.1.0
pytest-virtualenv==1.7.0
pytest-sphinx
pytest-sphinx @ git+https://github.com/ray-project/pytest-sphinx
redis==4.4.2
scikit-learn==1.0.2; python_version < '3.11'
smart_open[s3]==6.2.0
Expand Down

0 comments on commit 8d11931

Please sign in to comment.