Skip to content

Conversation

@lbliii
Copy link
Contributor

@lbliii lbliii commented Nov 24, 2025

looks like i dont need the docs/pyproject toml now based on the improvements @terrykong did to the root pyroject on my previous PR. removing the docs one will unblock the gitlab publishing pipeline so the docs can self update.

Summary by CodeRabbit

  • Chores
    • Updated documentation build environment and configuration setup for improved consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

Signed-off-by: Lawrence Lane <llane@nvidia.com>
@lbliii lbliii self-assigned this Nov 24, 2025
@lbliii lbliii requested a review from a team as a code owner November 24, 2025 15:54
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 24, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 24, 2025

📝 Walkthrough

Walkthrough

The documentation build system is being refactored to consolidate dependency management. The docs-specific pyproject.toml configuration is removed, and the Makefile's ensure-docs-env target is updated to use targeted uv sync with project-scoped group specification.

Changes

Cohort / File(s) Summary
Docs Build Configuration
docs/Makefile
Updated ensure-docs-env target to specify project TOML and docs group in uv sync invocation, changing from default/no-config to targeted, project-scoped sync
Docs Dependencies
docs/pyproject.toml
Removed complete configuration including project metadata, sphinx-related dependencies list, and no-lock directive

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify the uv sync command syntax with project and group arguments is correct
  • Confirm the docs group name in Makefile matches the corresponding group definition in the main project configuration
  • Ensure removal of docs-specific pyproject.toml doesn't break documentation build workflows

Suggested labels

CI:docs

Suggested reviewers

  • terrykong

Pre-merge checks and finishing touches

✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: remove doc pyproject toml' directly describes the main change: removal of docs/pyproject.toml file, matching the core objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Test Results For Major Changes ✅ Passed Pull request contains only minor configuration and build system changes related to documentation infrastructure consolidation with no impact on application code, numerics, convergence, or performance.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch llane/remove-doc-pyproject-toml

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a59436 and 86ac6a2.

⛔ Files ignored due to path filters (1)
  • docs/uv.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • docs/Makefile (1 hunks)
  • docs/pyproject.toml (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/pyproject.toml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: Docs_Tests
  • GitHub Check: sphinx-build / Build docs
  • GitHub Check: Lint check
  • GitHub Check: Post submodule check comment / Comment on PR
  • GitHub Check: Post automodel integration comment / Comment on PR
🔇 Additional comments (2)
docs/Makefile (2)

49-49: Root pyproject.toml is properly configured with a complete docs dependency group.

Verification confirms the root pyproject.toml defines [dependency-groups] with a docs group containing all necessary dependencies: sphinx, sphinx-autobuild, sphinx-autodoc2, sphinx-copybutton, sphinx-design, nvidia-sphinx-theme, sphinxcontrib-mermaid, and swagger-plugin-for-sphinx. The change to use uv sync --project ../pyproject.toml --group docs is correct and will function as intended.


40-52: All documentation build dependencies are properly configured in root pyproject.toml.

Verification confirms:

  • ✓ docs/pyproject.toml successfully removed
  • ✓ [dependency-groups].docs in root pyproject.toml contains all 11 required packages: sphinx, sphinx-autobuild, sphinx-autodoc2, sphinx-copybutton, sphinx-design, myst_parser, nvidia-sphinx-theme, gitpython, python-dotenv, sphinxcontrib-mermaid, swagger-plugin-for-sphinx
  • ✓ Python version constraint specified (>=3.12)
  • ✓ Makefile correctly references root pyproject.toml via ../pyproject.toml from docs/ directory
  • ✓ Migration is clean and complete

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@terrykong terrykong merged commit 9a84cc2 into main Nov 24, 2025
28 checks passed
@terrykong terrykong deleted the llane/remove-doc-pyproject-toml branch November 24, 2025 17:24
DeL-TaiseiOzaki pushed a commit to DeL-TaiseiOzaki/RL that referenced this pull request Jan 8, 2026
Signed-off-by: Lawrence Lane <llane@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants