[26.06] Ray Release: Documentation setup

CMakeLists.txt

@@ -0,0 +1 @@
+rocm_setup_version(VERSION 2.55.1)

LICENSE

@@ -271,8 +271,10 @@ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-------------------
-Code in python/ray/_private/prometheus_exporter.py is adapted from https://github.com/census-instrumentation/opencensus-python/blob/master/contrib/opencensus-ext-prometheus/opencensus/ext/prometheus/stats_exporter/__init__.py
+--------------------------------------------------------------------------------
+Code in python/ray/_private/prometheus_exporter.py is adapted from 
+https://github.com/census-instrumentation/opencensus-python/blob/master/contrib/
+opencensus-ext-prometheus/opencensus/ext/prometheus/stats_exporter/__init__.py
 
 # Copyright 2018, OpenCensus Authors
 #
@@ -361,7 +363,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 --------------------------------------------------------------------------------
-Code in python/ray/_private/runtime_env/_clonevirtualenv.py is adapted from https://github.com/edwardgeorge/virtualenv-clone/blob/master/clonevirtualenv.py
+Code in python/ray/_private/runtime_env/_clonevirtualenv.py is adapted from 
+https://github.com/edwardgeorge/virtualenv-clone/blob/master/clonevirtualenv.py
 
 Copyright (c) 2011, Edward George, based on code contained within the
 virtualenv project.
@@ -384,8 +387,10 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
----------------------------------------------------------------------------------------------------------------
-Code in python/ray/_private/thirdparty/tabulate/tabulate.py is adapted from https://github.com/astanin/python-tabulate/blob/4892c6e9a79638c7897ccea68b602040da9cc7a7/tabulate.py
+--------------------------------------------------------------------------------
+Code in python/ray/_private/thirdparty/tabulate/tabulate.py is adapted from 
+https://github.com/astanin/python-tabulate/blob/
+4892c6e9a79638c7897ccea68b602040da9cc7a7/tabulate.py
 
 Copyright (c) 2011-2020 Sergey Astanin and contributors
 
@@ -409,7 +414,8 @@ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 --------------------------------------------------------------------------------
-Code in python/ray/_private/thirdparty/dacite is adapted from https://github.com/konradhalas/dacite/blob/master/dacite
+Code in python/ray/_private/thirdparty/dacite is adapted from 
+https://github.com/konradhalas/dacite/blob/master/dacite
 
 Copyright (c) 2018 Konrad Hałas
 
@@ -433,7 +439,8 @@ SOFTWARE.
 
 --------------------------------------------------------------------------------
 
-Code in python/ray/autoscaler/_private/kuberay/utils.py is adapted from https://github.com/kubernetes-client/python/blob/master/kubernetes/utils/quantity.py
+Code in python/ray/autoscaler/_private/kuberay/utils.py is adapted from 
+https://github.com/kubernetes-client/python/blob/master/kubernetes/utils/quantity.py
 
 Copyright 2019 The Kubernetes Authors.
 
@@ -451,7 +458,8 @@ limitations under the License.
 
 --------------------------------------------------------------------------------
 
-Code in python/ray/_private/thirdparty/pynvml is adapted from https://pypi.org/project/nvidia-ml-py
+Code in python/ray/_private/thirdparty/pynvml is adapted from 
+https://pypi.org/project/nvidia-ml-py
 
 Copyright (c) 2011-2022, NVIDIA Corporation.
 All rights reserved.
@@ -483,7 +491,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 --------------------------------------------------------------------------------
 
-Code in src/ray/thirdparty/setproctitle is adapted from https://github.com/dvarrazzo/py-setproctitle
+Code in src/ray/thirdparty/setproctitle is adapted from 
+https://github.com/dvarrazzo/py-setproctitle
 
 BSD 3-Clause License
 

amd-docs/.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+sphinx:
+   configuration: amd-docs/conf.py
+
+# RTD by default builds html only
+# Additional formats available for extra build time: htmlzip, pdf, epub
+formats: []
+
+python:
+   install:
+   - requirements: amd-docs/sphinx/requirements.txt
+
+# Defines build environment
+build:
+   os: ubuntu-24.04
+   tools:
+      python: "3.12"

amd-docs/about/license.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: Ray license
+  :keywords: Ray, reinforcement learning, ROCm, developer, reference, python
+
+.. _license:
+
+******************************************
+License
+******************************************
+
+.. include:: ../../LICENSE
+  :literal:

amd-docs/conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import re
+
+'''
+html_theme is usually unchanged (rocm_docs_theme).
+flavor defines the site header display, select the flavor for the corresponding portals
+flavor options: rocm, rocm-docs-home, rocm-blogs, rocm-ds, instinct, ai-developer-hub, local, generic
+'''
+html_theme = "rocm_docs_theme"
+html_theme_options = {"flavor": "rocm-llmext", "repository_url": "https://github.com/AMD-Ecosystem/ray/"}
+
+'''
+docs_header_version is used to manually configure the version in the header. If
+there exists a non-null value mapped to docs_header_version, then the header in
+the documentation page will contain the given version string.
+'''
+html_context = {
+    "docs_header_version": "26.06"
+}
+
+
+# This section turns on/off article info
+setting_all_article_info = True
+all_article_info_os = ["linux"]
+all_article_info_author = ""
+
+# Dynamically extract component version
+with open('../CMakeLists.txt', encoding='utf-8') as f:
+    pattern = r'.*\brocm_setup_version\(VERSION\s+([0-9A-Za-z._-]+)' # Update according to each component's CMakeLists.txt
+    match = re.search(pattern,
+                      f.read())
+    if not match:
+        raise ValueError("VERSION not found!")
+    version_number = match[1]
+
+# for PDF output on Read the Docs
+project = "Ray"
+author = "Advanced Micro Devices, Inc."
+copyright = "Copyright (c) 2026 Advanced Micro Devices, Inc. All rights reserved."
+version = version_number
+release = version_number
+
+external_toc_path = "./sphinx/_toc.yml" # Defines Table of Content structure definition path
+
+# Add more additional packages accordingly
+extensions = [
+    "rocm_docs", 
+    "sphinx.ext.autodoc", # for Python docstrings
+] 
+
+html_title = f"{project} {version_number} documentation"
+
+external_projects_current_project = "Ray"

amd-docs/index.rst

@@ -0,0 +1,45 @@
+.. meta::
+  :description: Ray documentation
+  :keywords: Ray, ROCm, documentation, reinforcement learning, deep learning, framework, GPU
+
+.. _ray-documentation-index:
+
+********************************************************************
+Ray on ROCm documentation
+********************************************************************
+
+Use Ray on ROCm to orchestrate distributed GPU workloads across AMD Instinct
+clusters, enabling elastic hyperparameter tuning, reinforcement learning,
+and scalable end-to-end machine learning pipelines.
+
+Ray is a unified framework, consisting of `a core distributed 
+runtime  <https://docs.ray.io/en/latest/ray-core/walkthrough.html>`__ and a set of 
+`AI libraries <https://docs.ray.io/en/latest/ray-air/getting-started.html>`__ for 
+simplifying machine learning computations.
+
+Ray is part of the `AMD LLM Extension toolkit
+<https://rocm.docs.amd.com/projects/rocm-llmext/en/docs-26.02/>`__.
+
+The Ray public repository is located at `https://github.com/AMD-Ecosystem/ray <https://github.com/AMD-Ecosystem/ray>`__.
+
+.. grid:: 2
+  :gutter: 3
+
+  .. grid-item-card:: Install
+
+    * :doc:`Install Ray <install/ray-install>`
+
+  .. grid-item-card:: Examples
+
+      * `Ray examples (upstream) <https://docs.ray.io/en/latest/ray-overview/examples/index.html>`__
+      * `Ray use cases (upstream) <https://docs.ray.io/en/latest/ray-overview/use-cases.html>`__
+
+  .. grid-item-card:: Reference
+
+      * `Get started with Ray (upstream) <https://docs.ray.io/en/latest/ray-overview/getting-started.html>`__
+      * `Ray Core API (upstream) <https://docs.ray.io/en/latest/ray-core/api/index.html>`__
+
+To contribute to the documentation, refer to
+`Contributing to Ray <https://github.com/AMD-Ecosystem/ray/blob/master/CONTRIBUTING.rst>`__.
+
+You can find licensing information on the :doc:`Licensing <about/license>` page.