[DO NOT MERGE] Test submodule bump docs refresh

[vvbandeira]

No description provided.

[gemini-code-assist]

Code Review

This pull request vendors OpenROAD documentation files into the repository to enable offline, reproducible Sphinx builds instead of fetching them dynamically from GitHub. It introduces scripts to refresh and verify these vendored files, updates Python and Sphinx dependencies using uv, and adjusts build configurations. The review feedback suggests moving a local shutil import to the top of docs/conf.py to comply with PEP 8 and refactoring %-formatting to f-strings in the Python scripts for better readability.

[gemini-code-assist]

The shutil module is used here, but it's imported locally within the setup function. According to the PEP 8 style guide, imports should be at the top of the file. Please move import shutil to the top of docs/conf.py with the other imports to improve code organization and maintainability.

References

1. PEP 8: Imports should usually be on separate lines and at the top of the file, just after any module comments and docstrings, and before module globals and constants. ^(link)

[gemini-code-assist]

Throughout this script and refresh_openroad_docs.py, you're using %-formatting for strings. While this works, f-strings are generally preferred in modern Python (3.6+) for their improved readability and performance.

Consider refactoring these string formatting calls to use f-strings.

For example, this block could be rewritten as:

problems.append(
    f"the vendored OpenROAD docs are stale:\n"
    f"    {SOURCE_JSON.relative_to(REPO_ROOT)} says sha = {vendored}\n"
    f"    git rev-parse HEAD:{SUBMODULE_PATH}   = {pinned}\n"
    f"  The tools/OpenROAD submodule was bumped without re-vendoring "
    f"the documentation it ships. Fix with: {REFRESH_CMD}"
)

        problems.append(
            f"the vendored OpenROAD docs are stale:\n"
            f"    {SOURCE_JSON.relative_to(REPO_ROOT)} says sha = {vendored}\n"
            f"    git rev-parse HEAD:{SUBMODULE_PATH}   = {pinned}\n"
            f"  The tools/OpenROAD submodule was bumped without re-vendoring "
            f"the documentation it ships. Fix with: {REFRESH_CMD}"
        )

References

1. PEP 498 introduced f-strings, which are a more readable, concise, and less error-prone way of formatting strings in Python compared to older methods like %-formatting. ^(link)