Skip to content

Commit

Permalink
fix: updated the links in the docs after the scripts refactor (#27043)
Browse files Browse the repository at this point in the history
  • Loading branch information
vedpatwardhan committed Oct 17, 2023
1 parent bcddc79 commit bbf1ca6
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
24 changes: 12 additions & 12 deletions docs/overview/contributing/setting_up.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Setting Up
.. _`pip packages channel`: https://discord.com/channels/799879767196958751/942114789642080317
.. _`miniconda`: https://docs.conda.io/en/latest/miniconda.html
.. _`venv`: https://docs.python.org/3/library/venv.html
.. _`ivy/scripts/shell`: https://github.com/unifyai/ivy/tree/f71a414417646e1dfecb5de27fb555f80333932c/scripts/shell
.. _`ivy/scripts`: https://github.com/unifyai/ivy/tree/bcddc79978afe447958dfa3ea660716845c85846/scripts
.. _`platform compatibility tags`: https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/
.. _`logging level`: https://docs.python.org/3/library/logging.html#logging.Logger.setLevel

Expand Down Expand Up @@ -488,21 +488,21 @@ Click this and you should see a progress bar of all the tests running in the fil
:width: 420

It is also possible to run the entire set of ivy tests or the array api test suite using pre-written shell scripts that can be run from the 'Terminal' tab in PyCharm.
There are a number of such shell scripts in `ivy/scripts/shell`_:
There are a number of such shell scripts in `ivy/scripts`_:

.. code-block:: bash
:emphasize-lines: 4,5,8,9,10
run_ivy_core_test.py
run_ivy_nn_test.py
run_ivy_stateful_test.py
run_tests.sh
scripts/setup_tests/run_ivy_core_test.py
scripts/setup_tests/run_ivy_nn_test.py
scripts/setup_tests/run_ivy_stateful_test.py
scripts/shell/run_tests.sh
scripts/shell/test_array_api.sh
test_dependencies.py
scripts/test_dependencies.py
scripts/shell/test_dependencies.sh
test_ivy_core.sh
test_ivy_nn.sh
test_ivy_stateful.sh
scripts/shell/test_ivy_core.sh
scripts/shell/test_ivy_nn.sh
scripts/shell/test_ivy_stateful.sh
**For Unix-based systems (Linux and macOS):**

Expand All @@ -512,7 +512,7 @@ There are a number of such shell scripts in `ivy/scripts/shell`_:
This runs all array-api tests for a certain submodule in a certain backend.
* :code:`scripts/shell/test_ivy_core.sh` is run by typing :code:`./scripts/shell/test_ivy_core.sh [backend] test_[submodule]` in the ivy directory.
This runs all ivy tests for a certain submodule in a certain backend in :code:`test_ivy/test_functional/test_core`.
* :code:`scripts/shell/test_ivy_nn.sh`, :code:`test_ivy_stateful.sh` are run in a similar manner to :code:`scripts/shell/test_ivy_core.sh`.
* :code:`scripts/shell/test_ivy_nn.sh`, :code:`scripts/shell/test_ivy_stateful.sh` are run in a similar manner to :code:`scripts/shell/test_ivy_core.sh`.
Make sure to check the submodule names in the source code before running.

.. image:: https://github.com/unifyai/unifyai.github.io/blob/main/img/externally_linked/contributing/setting_up/setting_up_testing/pycharm_run_array_api_tests.png?raw=true
Expand All @@ -530,7 +530,7 @@ For Windows users, you may need to specify that the shell scripts should be run
This runs all array-api tests for a certain submodule in a certain backend.
* To run :code:`scripts/shell/test_ivy_core.sh` on Windows, type :code:`sh ./scripts/shell/test_ivy_core.sh [backend] test_[submodule]` in the ivy directory.
This runs all ivy tests for a certain submodule in a certain backend in :code:`test_ivy/test_functional/test_core`.
* :code:`scripts/shell/test_ivy_nn.sh`, :code:`test_ivy_stateful.sh` are run in a similar manner to :code:`scripts/shell/test_ivy_core.sh` on Windows.
* :code:`scripts/shell/test_ivy_nn.sh`, :code:`scripts/shell/test_ivy_stateful.sh` are run in a similar manner to :code:`scripts/shell/test_ivy_core.sh` on Windows.
Make sure to check the submodule names in the source code before running.

The above instructions for running tests on Windows assume that you have installed Git and have access to the Git Bash terminal. If you do not have Git Bash, you can download it from the `official Git website <https://git-scm.com/downloads>`_.
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/contributing/the_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ This can be done using:
The main branch then simply has the role of being kept up to date with upstream.
You *can* create PRs based on the main branch of your fork, but this will make things more complicated if you would then like to create additional PRs in the future.

For keeping any branch on your fork up to date, there is a script in the root folder of the repo `scripts/shell/merge_with_upstream.sh <https://github.com/unifyai/ivy/blob/2994da4f7347b0b3fdd81b91c83bcbaa5580e7fb/scripts/shell/merge_with_upstream.sh>`_.
For keeping any branch on your fork up to date, there is a script in the root folder of the repo `scripts/shell/merge_with_upstream.sh <https://github.com/unifyai/ivy/blob/bcddc79978afe447958dfa3ea660716845c85846/scripts/shell/merge_with_upstream.sh>`_.
To update your fork's branch to the upstream main branch, simply run :code:`./scripts/shell/merge_with_upstream.sh name_of_your_branch`.
To update the main branch, this would then be: :code:`./scripts/shell/merge_with_upstream.sh main`.

Expand Down
2 changes: 1 addition & 1 deletion docs/overview/deep_dive/array_api_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Array API Tests
.. _`repo`: https://github.com/unifyai/ivy
.. _`discord`: https://discord.gg/sXyFF8tDtm
.. _`array api tests channel`: https://discord.com/channels/799879767196958751/982738404611592256
.. _`scripts/shell/test_array_api.sh`: https://github.com/unifyai/ivy/blob/d76f0f5ab02d608864eb2c4012af2404da5806c2/scripts/shell/test_array_api.sh
.. _`scripts/shell/test_array_api.sh`: https://github.com/unifyai/ivy/blob/bcddc79978afe447958dfa3ea660716845c85846/scripts/shell/test_array_api.sh
.. _`array-api test repository`: https://github.com/data-apis/array-api/tree/main
.. _`issue`: https://github.com/numpy/numpy/issues/21213
.. _`ivy_tests/array_api_testing/test_array_api/array_api_tests/test_special_cases.py`: https://github.com/data-apis/array-api-tests/blob/ddd3b7a278cd0c0b68c0e4666b2c9f4e67b7b284/array_api_tests/test_special_cases.py
Expand Down

0 comments on commit bbf1ca6

Please sign in to comment.