Switches over to nvidia-sphinx-theme

[Mayankm96]

Description

This MR moves our docs to use the standardized template from NVIDIA.

Type of change

• New feature (non-breaking change which adds functionality)
• Documentation update

Screenshots

Checklist

• I have read and understood the contribution guidelines
• I have run the pre-commit checks with ./isaaclab.sh --format
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• I have updated the changelog and the corresponding version in the extension's config/extension.toml file
• I have added my name to the CONTRIBUTORS.md or my name already exists there

[greptile-apps]

Greptile Summary

This PR migrates the Isaac Lab documentation from sphinx_book_theme to the standardized nvidia_sphinx_theme, aligning with NVIDIA's documentation standards. The changes include:

• Theme Migration: Replaced sphinx_book_theme with nvidia_sphinx_theme and updated configuration options in docs/conf.py to match the new theme's API
• Dynamic Version Switcher: Added generate_switcher.py script that dynamically generates version dropdown data from git tags and branches, replacing the previous static versioning template
• Simplified Styling: Removed custom CSS theme overrides since the NVIDIA theme provides built-in styling
• Build Process Update: Modified Makefile to run switcher generation before building multi-version docs
• Documentation Fixes: Fixed import path in actions_cfg.py to use package-level exports and corrected RST module references in isaaclab.devices.rst

Issue Found: The PyTorch intersphinx URL was changed to https://docs.pytorch.org/docs/stable/ which appears to have an extra /docs in the path and may cause broken cross-references to PyTorch documentation.

Confidence Score: 4/5

• This PR is safe to merge with one URL fix needed
• The documentation theme migration is well-structured and complete. The new version switcher script is properly implemented with error handling. However, there's a syntax error in the PyTorch documentation URL that will cause broken cross-references to PyTorch documentation. Once this URL is corrected, the PR will be ready to merge.
• Pay attention to docs/conf.py line 127 - the PyTorch URL needs correction before merging

Important Files Changed

Filename	Overview
docs/conf.py	Migrated from sphinx_book_theme to nvidia_sphinx_theme with updated configuration options and intersphinx URL
docs/generate_switcher.py	New script to dynamically generate version switcher JSON from git tags and branches
docs/Makefile	Added switcher generation step to multi-docs build with improved output messages

Sequence Diagram

sequenceDiagram
    participant User
    participant Makefile
    participant GenerateSwitcher as generate_switcher.py
    participant Git
    participant SphinxMultiversion
    participant NvidiaTheme as nvidia_sphinx_theme

    User->>Makefile: make multi-docs
    Makefile->>GenerateSwitcher: Execute generate_switcher.py
    GenerateSwitcher->>Git: git tag -l
    Git-->>GenerateSwitcher: Return tags (v2.3.1, v2.3.0, etc.)
    GenerateSwitcher->>Git: git branch -r
    Git-->>GenerateSwitcher: Return branches (main)
    GenerateSwitcher->>GenerateSwitcher: Filter and sort versions
    GenerateSwitcher->>GenerateSwitcher: Write switcher.json
    GenerateSwitcher-->>Makefile: Switcher generated
    
    Makefile->>SphinxMultiversion: Build docs for all versions
    loop For each version
        SphinxMultiversion->>NvidiaTheme: Render with nvidia_sphinx_theme
        NvidiaTheme->>NvidiaTheme: Load switcher.json
        NvidiaTheme->>NvidiaTheme: Apply NVIDIA branding
        NvidiaTheme-->>SphinxMultiversion: Version docs built
    end
    
    SphinxMultiversion-->>Makefile: Multi-version build complete
    Makefile->>Makefile: Copy redirect page
    Makefile-->>User: Documentation ready

Loading

[greptile-apps]

_{9 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}