Skip to content

[docs] Add examples.yml header instructions #64237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
linh285 wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −0
Open

[docs] Add examples.yml header instructions #64237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/source/data/examples.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# This file is used to auto-generate the Examples Gallery page.
# Do not edit the generated examples.rst page directly.
# To request formatting changes to the generated page, file an issue with the Ray docs team.
# To reference the generated page, use examples.html.

@gemini-code-assist gemini-code-assist Bot Jun 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In Sphinx, referencing other documentation pages should be done using the :doc: role (e.g., :doc:/data/examples) rather than hardcoding the .html extension.

Hardcoding .html links is an anti-pattern in Sphinx because:

  1. It bypasses Sphinx's link validation (Sphinx won't warn you if the target file is moved or deleted).
  2. It can break if the documentation is built using a non-HTML builder (like PDF or EPUB).

Consider updating this instruction to recommend the :doc: role:

To reference the generated page, use :doc:/data/examples.

# When adding a new example, include the skill level and framework, if applicable.

text: Below are examples for using Ray Data for batch inference workloads or large-scale data processing with a variety of frameworks and use cases.
columns_to_show:
- frameworks
Expand Down
6 changes: 6 additions & 0 deletions doc/source/serve/examples.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# This file is used to auto-generate the Examples Gallery page.
# Do not edit the generated examples.rst page directly.
# To request formatting changes to the generated page, file an issue with the Ray docs team.
# To reference the generated page, use examples.html.

@gemini-code-assist gemini-code-assist Bot Jun 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In Sphinx, referencing other documentation pages should be done using the :doc: role (e.g., :doc:/serve/examples) rather than hardcoding the .html extension.

Hardcoding .html links is an anti-pattern in Sphinx because:

  1. It bypasses Sphinx's link validation (Sphinx won't warn you if the target file is moved or deleted).
  2. It can break if the documentation is built using a non-HTML builder (like PDF or EPUB).

Consider updating this instruction to recommend the :doc: role:

To reference the generated page, use :doc:/serve/examples.

# When adding a new example, include the skill level and framework, if applicable.

text: Below are tutorials for exploring Ray Serve capabilities and learning how to integrate different modeling frameworks.
groupby: related_technology
examples:
Expand Down
6 changes: 6 additions & 0 deletions doc/source/train/examples.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# This file is used to auto-generate the Examples Gallery page.
# Do not edit the generated examples.rst page directly.
# To request formatting changes to the generated page, file an issue with the Ray docs team.
# To reference the generated page, use examples.html.

@gemini-code-assist gemini-code-assist Bot Jun 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In Sphinx, referencing other documentation pages should be done using the :doc: role (e.g., :doc:/train/examples) rather than hardcoding the .html extension.

Hardcoding .html links is an anti-pattern in Sphinx because:

  1. It bypasses Sphinx's link validation (Sphinx won't warn you if the target file is moved or deleted).
  2. It can break if the documentation is built using a non-HTML builder (like PDF or EPUB).

Consider updating this instruction to recommend the :doc: role:

To reference the generated page, use :doc:/train/examples.

# When adding a new example, include the skill level and framework, if applicable.

text: Below are examples for using Ray Train with a variety of frameworks and use cases. Ray Train makes it easy to scale out each of these examples to a large cluster of GPUs.
columns_to_show:
- frameworks
Expand Down
Loading