Skip to content

[docs] using ray-project pandas mirror for doc builds#61730

Merged
aslonnie merged 1 commit intomasterfrom
elliot-barn-pandas-object-mirror-doc-build
Mar 14, 2026
Merged

[docs] using ray-project pandas mirror for doc builds#61730
aslonnie merged 1 commit intomasterfrom
elliot-barn-pandas-object-mirror-doc-build

Conversation

@elliot-barn
Copy link
Contributor

@elliot-barn elliot-barn commented Mar 13, 2026

creating object mirror for pandas for ray doc builds

cloned pandas repo and added objects.inv as an artifact

Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
@elliot-barn elliot-barn requested a review from a team as a code owner March 13, 2026 21:51
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the Sphinx configuration to use a mirrored objects.inv file for the pandas library documentation, which is a good practice for ensuring build stability. My review includes a suggestion to improve maintainability by refactoring the hardcoded mirror version into a constant, as this version is shared with the scipy configuration.

Comment on lines +837 to +840
"pandas": (
"https://pandas.pydata.org/pandas-docs/stable/",
"https://github.com/ray-project/pandas/releases/download/object-mirror-0.1.0/objects.inv",
),
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For better maintainability, consider defining the version string object-mirror-0.1.0 as a constant. This version is also used for the scipy intersphinx mapping. By using a constant, you can ensure that both mappings are updated consistently in the future.

For example:

_OBJECT_MIRROR_VERSION = "object-mirror-0.1.0"

intersphinx_mapping = {
    # ...
    "pandas": (
        "https://pandas.pydata.org/pandas-docs/stable/",
        f"https://github.com/ray-project/pandas/releases/download/{_OBJECT_MIRROR_VERSION}/objects.inv",
    ),
    # ...
    "scipy": (
        "https://docs.scipy.org/doc/scipy/",
        f"https://github.com/ray-project/scipy/releases/download/{_OBJECT_MIRROR_VERSION}/objects.inv",
    ),
    # ...
}

@elliot-barn elliot-barn requested a review from aslonnie March 13, 2026 22:50
@elliot-barn elliot-barn added the go add ONLY when ready to merge, run all tests label Mar 14, 2026
@ray-gardener ray-gardener bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core labels Mar 14, 2026
@aslonnie aslonnie merged commit fb0073f into master Mar 14, 2026
9 checks passed
@aslonnie aslonnie deleted the elliot-barn-pandas-object-mirror-doc-build branch March 14, 2026 02:31
abrarsheikh pushed a commit that referenced this pull request Mar 17, 2026
creating object mirror for pandas for ray doc builds 

cloned pandas repo and added objects.inv as an artifact

Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
Signed-off-by: abrar <abrar@anyscale.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Issues that should be addressed in Ray Core docs An issue or change related to documentation go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants