From 0a992c4dda195de5df9632af51c26e2b12576f6a Mon Sep 17 00:00:00 2001 From: Haris Mahmood Date: Sat, 19 Oct 2024 12:10:42 +0500 Subject: [PATCH] fix: Update docs removing YT videos --- docs/overview/contributing.rst | 10 ++--- docs/overview/contributing/open_tasks.rst | 10 ++--- docs/overview/contributing/setting_up.rst | 40 +++++++++---------- docs/overview/contributing/the_basics.rst | 40 +++++++++---------- docs/overview/deep_dive/array_api_tests.rst | 10 ++--- docs/overview/deep_dive/arrays.rst | 10 ++--- docs/overview/deep_dive/backend_setting.rst | 10 ++--- docs/overview/deep_dive/containers.rst | 10 ++--- docs/overview/deep_dive/data_types.rst | 10 ++--- docs/overview/deep_dive/devices.rst | 10 ++--- .../overview/deep_dive/docstring_examples.rst | 10 ++--- docs/overview/deep_dive/docstrings.rst | 10 ++--- .../overview/deep_dive/exception_handling.rst | 10 ++--- docs/overview/deep_dive/formatting.rst | 10 ++--- .../overview/deep_dive/function_arguments.rst | 10 ++--- docs/overview/deep_dive/function_types.rst | 10 ++--- docs/overview/deep_dive/function_wrapping.rst | 10 ++--- docs/overview/deep_dive/gradients.rst | 10 ++--- docs/overview/deep_dive/inplace_updates.rst | 10 ++--- docs/overview/deep_dive/ivy_frontends.rst | 11 +++-- .../deep_dive/ivy_frontends_tests.rst | 10 ++--- docs/overview/deep_dive/ivy_tests.rst | 10 ++--- .../deep_dive/navigating_the_code.rst | 10 ++--- .../overview/deep_dive/superset_behaviour.rst | 10 ++--- docs/overview/get_started.rst | 2 +- 25 files changed, 151 insertions(+), 152 deletions(-) diff --git a/docs/overview/contributing.rst b/docs/overview/contributing.rst index 21cf4bf72fe3..67cb59e21ec6 100644 --- a/docs/overview/contributing.rst +++ b/docs/overview/contributing.rst @@ -45,10 +45,10 @@ The contributor guide is split into the sections below, it's best to go from sta contributing/helpful_resources.rst contributing/error_handling.rst -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/contributing/open_tasks.rst b/docs/overview/contributing/open_tasks.rst index 30ba3cd91ee9..f184b02bd361 100644 --- a/docs/overview/contributing/open_tasks.rst +++ b/docs/overview/contributing/open_tasks.rst @@ -62,13 +62,13 @@ Ensure that your solution addresses the issue effectively and doesn't introduce Once you're confident in your fix, submit a pull request to the main repository. Our team will review your contribution, provide feedback if necessary, and then merge your changes once we're good to go. -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. Frontend APIs ------------- diff --git a/docs/overview/contributing/setting_up.rst b/docs/overview/contributing/setting_up.rst index edf37e1f33ff..62473686136d 100644 --- a/docs/overview/contributing/setting_up.rst +++ b/docs/overview/contributing/setting_up.rst @@ -323,13 +323,13 @@ If Docker's latest version causes an error, try using an earlier version by visi For some Windows users, it might be necessary to enable virtualisation from the BIOS setup. -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. MacOS @@ -363,13 +363,13 @@ If Docker's latest version causes an error, try using an earlier version by visi When setting up on an M1 Mac, you would have to update the Dockerfile to install libraries from :code:`requirements/optional_apple_silicon_1.txt` and :code:`requirements/optional_apple_silicon_2.txt` instead of :code:`requirements/optional.txt`. -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. Ubuntu @@ -447,13 +447,13 @@ This is a common error which you might face. If you are not successfully able to For questions, please reach out on `discord`_ in the `docker thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. Setting Up Testing in PyCharm ----------------------------- @@ -881,13 +881,13 @@ Running a :code:`pip install -e .` is sufficient to download the binaries if the .. note:: Bear in mind that the binaries are **not** required for working on the open tasks for the most part, so it's totally fine to not have the binaries downloaded on your system for working on any of the open tasks. -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. **Round Up** diff --git a/docs/overview/contributing/the_basics.rst b/docs/overview/contributing/the_basics.rst index 7a12d40d01d1..eeccd27cbba2 100644 --- a/docs/overview/contributing/the_basics.rst +++ b/docs/overview/contributing/the_basics.rst @@ -34,13 +34,13 @@ For example, if you are applying for an internship, then you should make use of As the name suggests, the `issues `_ section on GitHub is the best place to raise issues or general bugs that you find with the project. It can also serve as a useful place to ask questions, but only if you suspect that the behaviour you are observing *might* be a bug. -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. | @@ -102,13 +102,13 @@ This is to prevent anyone from self-allocating many sub-tasks, preventing others Even though the limit is three, sub-tasks should only be self-assigned using **one comment per sub-task**. For example, a sequence of comments like this :code:`- [ ] #Issue_number` will register correctly whereas a single comment like this :code:`- [ ] #Issue_number, - [ ] #Issue_number, - [ ] #Issue_number` or this :code:`- [ ] #Issue_number #Issue_number #Issue_number` etc. will not. -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. | @@ -143,13 +143,13 @@ The corresponding commands are :code:`git stash` -> :code:`git fetch` -> :code:` Note that this only works for uncommitted changes (staged and unstaged) and untracked files won't be stashed. For a comprehensive explanation of git stashing, check out this `Atlassian tutorial`_. -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. | @@ -238,13 +238,13 @@ This will enable us to quickly fix conflicts, merge with upstream, and get thing The code review process is explained in more detail in the following video. -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. | diff --git a/docs/overview/deep_dive/array_api_tests.rst b/docs/overview/deep_dive/array_api_tests.rst index f2b52bcf576f..a36279252a80 100644 --- a/docs/overview/deep_dive/array_api_tests.rst +++ b/docs/overview/deep_dive/array_api_tests.rst @@ -205,10 +205,10 @@ This should have hopefully given you a good understanding of how the Array API t If you have any questions, please feel free to reach out on `discord`_ in the `array api tests thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/arrays.rst b/docs/overview/deep_dive/arrays.rst index b88d1a3e2783..de91358324ce 100644 --- a/docs/overview/deep_dive/arrays.rst +++ b/docs/overview/deep_dive/arrays.rst @@ -179,10 +179,10 @@ This should have hopefully given you a good feel for the different types of arra If you have any questions, please feel free to reach out on `discord`_ in the `arrays thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/backend_setting.rst b/docs/overview/deep_dive/backend_setting.rst index 4dd844a10e3b..0cdb58630c9c 100644 --- a/docs/overview/deep_dive/backend_setting.rst +++ b/docs/overview/deep_dive/backend_setting.rst @@ -132,10 +132,10 @@ This should have hopefully given you a good feel for how the backend framework i If you have any questions, please feel free to reach out on `discord`_ in the `backend setting thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/containers.rst b/docs/overview/deep_dive/containers.rst index bcec9335375b..6a8c35d3ef3e 100644 --- a/docs/overview/deep_dive/containers.rst +++ b/docs/overview/deep_dive/containers.rst @@ -337,10 +337,10 @@ This should have hopefully given you a good feel for containers, and how these a If you have any questions, please feel free to reach out on `discord`_ in the `containers thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/data_types.rst b/docs/overview/deep_dive/data_types.rst index 6e5f10d9fe86..d5e22f8e69fb 100644 --- a/docs/overview/deep_dive/data_types.rst +++ b/docs/overview/deep_dive/data_types.rst @@ -742,10 +742,10 @@ This should have hopefully given you a good feel for data types, and how these a If you have any questions, please feel free to reach out on `discord`_ in the `data types thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/devices.rst b/docs/overview/deep_dive/devices.rst index 432b20cc4ca7..91d1d2936ec2 100644 --- a/docs/overview/deep_dive/devices.rst +++ b/docs/overview/deep_dive/devices.rst @@ -273,10 +273,10 @@ This should have hopefully given you a good feel for devices, and how these are If you have any questions, please feel free to reach out on `discord`_ in the `devices thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/docstring_examples.rst b/docs/overview/deep_dive/docstring_examples.rst index 271109ff6c7d..fe9740227a51 100644 --- a/docs/overview/deep_dive/docstring_examples.rst +++ b/docs/overview/deep_dive/docstring_examples.rst @@ -750,10 +750,10 @@ These three examples should give you a good understanding of what is required wh If you have any questions, please feel free to reach out on `discord`_ in the `docstring examples thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/docstrings.rst b/docs/overview/deep_dive/docstrings.rst index 8d352ce73c29..9e25a74d5dbd 100644 --- a/docs/overview/deep_dive/docstrings.rst +++ b/docs/overview/deep_dive/docstrings.rst @@ -196,10 +196,10 @@ These examples should hopefully give you a good understanding of what is require If you have any questions, please feel free to reach out on `discord`_ in the `docstrings thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/exception_handling.rst b/docs/overview/deep_dive/exception_handling.rst index 6b3090294023..e5f44fa5eb11 100644 --- a/docs/overview/deep_dive/exception_handling.rst +++ b/docs/overview/deep_dive/exception_handling.rst @@ -547,10 +547,10 @@ This should have hopefully given you a good feel for how function wrapping is ap If you have any questions, please feel free to reach out on `discord`_ in the `exception handling thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/formatting.rst b/docs/overview/deep_dive/formatting.rst index 2d6aa8f5e87b..e75973d7160a 100644 --- a/docs/overview/deep_dive/formatting.rst +++ b/docs/overview/deep_dive/formatting.rst @@ -194,10 +194,10 @@ to Ivy. If you have any questions, please feel free to reach out on `discord`_ in the `formatting thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/function_arguments.rst b/docs/overview/deep_dive/function_arguments.rst index 6965e74cde26..c6c035caea29 100644 --- a/docs/overview/deep_dive/function_arguments.rst +++ b/docs/overview/deep_dive/function_arguments.rst @@ -213,10 +213,10 @@ These examples should hopefully give you a good understanding of what is require If you have any questions, please feel free to reach out on `discord`_ in the `function arguments thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/function_types.rst b/docs/overview/deep_dive/function_types.rst index d78785ffe092..3cd0b7ab8dc0 100644 --- a/docs/overview/deep_dive/function_types.rst +++ b/docs/overview/deep_dive/function_types.rst @@ -251,10 +251,10 @@ This should have hopefully given you a good feel for the different function type If you have any questions, please feel free to reach out on `discord`_ in the `function types thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/function_wrapping.rst b/docs/overview/deep_dive/function_wrapping.rst index ce601a997d84..a7bf6e6b0ec9 100644 --- a/docs/overview/deep_dive/function_wrapping.rst +++ b/docs/overview/deep_dive/function_wrapping.rst @@ -154,10 +154,10 @@ This should have hopefully given you a good feel for how function wrapping is ap If you have any questions, please feel free to reach out on `discord`_ in the `function wrapping thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/gradients.rst b/docs/overview/deep_dive/gradients.rst index af6f0b7eedc1..1be2b89d476f 100644 --- a/docs/overview/deep_dive/gradients.rst +++ b/docs/overview/deep_dive/gradients.rst @@ -175,10 +175,10 @@ This should have hopefully given you a good feel for how the gradient API is imp If you have any questions, please feel free to reach out on `discord`_ in the `gradients thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/inplace_updates.rst b/docs/overview/deep_dive/inplace_updates.rst index 739f31825f95..282a826abf22 100644 --- a/docs/overview/deep_dive/inplace_updates.rst +++ b/docs/overview/deep_dive/inplace_updates.rst @@ -514,10 +514,10 @@ This should have hopefully given you a good feel for inplace updates, and how th If you have any questions, please feel free to reach out on `discord`_ in the `inplace updates thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/ivy_frontends.rst b/docs/overview/deep_dive/ivy_frontends.rst index ffc51ae6f546..4479427e4b6e 100644 --- a/docs/overview/deep_dive/ivy_frontends.rst +++ b/docs/overview/deep_dive/ivy_frontends.rst @@ -674,15 +674,14 @@ Unit tests should be written for all aliases. This is arguably a duplication, bu **Round Up** This should hopefully have given you a better grasp on what the Ivy Frontend APIs are for, how they should be implemented, and the things to watch out for! -We also have a short `YouTube tutorial series`_ on this as well if you prefer a video explanation! If you have any questions, please feel free to reach out on `discord`_ in the `ivy frontends thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/ivy_frontends_tests.rst b/docs/overview/deep_dive/ivy_frontends_tests.rst index 9087eb5d234b..ec197c00ef5f 100644 --- a/docs/overview/deep_dive/ivy_frontends_tests.rst +++ b/docs/overview/deep_dive/ivy_frontends_tests.rst @@ -818,10 +818,10 @@ This should have hopefully given you a good understanding of Ivy Frontend Tests! If you have any questions, please feel free to reach out on `discord`_ in the `ivy frontends tests thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/ivy_tests.rst b/docs/overview/deep_dive/ivy_tests.rst index 83212d52ca24..127b53611d2f 100644 --- a/docs/overview/deep_dive/ivy_tests.rst +++ b/docs/overview/deep_dive/ivy_tests.rst @@ -942,10 +942,10 @@ This should have hopefully given you a good feel for how the tests are implement If you have any questions, please feel free to reach out on `discord`_ in the `ivy tests thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/navigating_the_code.rst b/docs/overview/deep_dive/navigating_the_code.rst index 3bef6c41644f..41b0332855c7 100644 --- a/docs/overview/deep_dive/navigating_the_code.rst +++ b/docs/overview/deep_dive/navigating_the_code.rst @@ -302,10 +302,10 @@ This should have hopefully given you a good feel for how to navigate the Ivy cod If you have any questions, please feel free to reach out on `discord`_ in the `navigating the code thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/deep_dive/superset_behaviour.rst b/docs/overview/deep_dive/superset_behaviour.rst index 67b2573f8258..1f0b1359258d 100644 --- a/docs/overview/deep_dive/superset_behaviour.rst +++ b/docs/overview/deep_dive/superset_behaviour.rst @@ -269,10 +269,10 @@ If you find yourself proposing the addition of a new function in Ivy, then we wi If you have any questions, please feel free to reach out on `discord`_ in the `superset behavior thread`_! -**Video** +.. **Video** -.. raw:: html +.. .. raw:: html - +.. diff --git a/docs/overview/get_started.rst b/docs/overview/get_started.rst index 417e8bc1ff30..69ef22a1b256 100644 --- a/docs/overview/get_started.rst +++ b/docs/overview/get_started.rst @@ -34,7 +34,7 @@ When installing from source, we recommend installing ivy's dev dependencies with pip install -r requirements/optional.txt There are also other 'requirements/optional...' files in the 'requirements' folder that -can be install the dependencies for specific hardware, such as GPU machines or Apple silicon. +can be used to install the dependencies for specific hardware, such as GPU machines or Apple silicon. If you are planning to contribute, you want to run the tests, or you are looking for more in-depth instructions, it's probably best to check out