Skip to content

docs: enable public_docs_features in Sphinx configuration#484

Closed
stringsbuilder wants to merge 1 commit intoNVIDIA:mainfrom
stringsbuilder:main
Closed

docs: enable public_docs_features in Sphinx configuration#484
stringsbuilder wants to merge 1 commit intoNVIDIA:mainfrom
stringsbuilder:main

Conversation

@stringsbuilder
Copy link
Copy Markdown

@stringsbuilder stringsbuilder commented Mar 20, 2026

Summary

The documentation is now public with GitHub repository, Discord channel, and public preview announced since March 16, 2026.

Enable the public_docs_features option in the NVIDIA Sphinx theme configuration.

Related Issue

Changes

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only. Prose changes without code sample modifications.
  • Doc only. Includes code sample changes.

Testing

  • make check passes.
  • npm test passes.
  • make docs builds without warnings. (for doc-only changes)

Checklist

General

Code Changes

  • make format applied (TypeScript and Python).
  • Tests added or updated for new or changed behavior.
  • No secrets, API keys, or credentials committed.
  • Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).

Doc Changes

  • Follows the style guide. Try running the update-docs agent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docs catch up the docs for the new changes I made in this PR."
  • New pages include SPDX license header and frontmatter, if creating a new page.
  • Cross-references and links verified.

Summary by CodeRabbit

  • Documentation
    • Enabled public documentation features in the Sphinx HTML theme configuration.

Signed-off-by: stringsbuilder <stringsbuilder@outlook.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: bab9076c-e2d1-4d52-a716-7a0e24cd226e

📥 Commits

Reviewing files that changed from the base of the PR and between dbfd78c and aa363d8.

📒 Files selected for processing (1)
  • docs/conf.py

📝 Walkthrough

Walkthrough

The docs/conf.py configuration file is updated to enable the "public_docs_features" setting in the Sphinx HTML theme options, replacing a previously commented-out TODO line with the active configuration.

Changes

Cohort / File(s) Summary
Sphinx Configuration
docs/conf.py
Enables "public_docs_features": True in html_theme_options by replacing a commented TODO line with the active setting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A feature emerges from comments deep,
Like carrots unearthed from their sleep,
The docs now shine with public grace,
As configurations find their place! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and clearly describes the main change: enabling the public_docs_features setting in Sphinx configuration, which matches the actual modification in docs/conf.py.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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

Tip

CodeRabbit can suggest fixes for GitHub Check annotations.

Configure the reviews.tools.github-checks setting to adjust the time to wait for GitHub Checks to complete.

@wscurran wscurran added Integration: Discord Use this label to identify Discord bot integration issues with NemoClaw. documentation Improvements or additions to documentation labels Mar 20, 2026
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 Integration: Discord Use this label to identify Discord bot integration issues with NemoClaw.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants