Skip to content

Remove obsolete Doxygen and Sphinx documentation tooling - #2649

Merged
rapids-bot[bot] merged 5 commits into
NVIDIA:mainfrom
bdice:remove-legacy-docs-tooling
Oct 8, 2026
Merged

rapids-bot[bot] merged 5 commits into
NVIDIA:mainfrom
bdice:remove-legacy-docs-tooling

Conversation

@bdice

@bdice bdice commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

cuVS builds its documentation with Fern, whose API generator reads source files directly rather than consuming Doxygen XML.

  • Remove unused cpp/doxygen/ assets and stale CI, lint, and ignore rules.
  • Update contributor instructions, documentation links, and CodeRabbit guidance for Fern.
  • Reduce docs-only dependencies to Python and Node.js, leaving build/test environments unchanged.

Doxygen-style source comments and Sphinx-role parsing remain in use and are preserved. No public API or generated API content changes.

Supersedes #2609.

@bdice
bdice requested review from a team as code owners September 17, 2026 20:17
@bdice bdice added doc Improvements or additions to documentation improvement Improves an existing functionality labels Sep 17, 2026
@bdice bdice self-assigned this Sep 17, 2026
Comment thread fern/README.md
Comment on lines +7 to +8
The API generator reads source files directly, including Doxygen-style C/C++ comments and Sphinx-style roles in Python docstrings. It does not require the Doxygen or Sphinx executables or generated XML.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm fine with keeping or removing this sentence. Up to reviewers.

Suggested change
The API generator reads source files directly, including Doxygen-style C/C++ comments and Sphinx-style roles in Python docstrings. It does not require the Doxygen or Sphinx executables or generated XML.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's leave it in

@bdice bdice added non-breaking Introduces a non-breaking change and removed improvement Improves an existing functionality labels Sep 17, 2026
Comment thread fern/README.md
Comment on lines +7 to +8
The API generator reads source files directly, including Doxygen-style C/C++ comments and Sphinx-style roles in Python docstrings. It does not require the Doxygen or Sphinx executables or generated XML.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's leave it in

@vuule vuule mentioned this pull request Sep 21, 2026

@dantegd dantegd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Cleanup looks good to me

@cjnolet

cjnolet commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

/merge

@bdice bdice changed the title [REVIEW] Remove obsolete Doxygen and Sphinx documentation tooling Remove obsolete Doxygen and Sphinx documentation tooling Oct 5, 2026
@coderabbitai

coderabbitai Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/cuvs/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 28bd6d28-1ed0-44fe-af8b-edb257144fb3
📥 Commits

Reviewing files that changed from the base of the PR and between 53c7b80 and 270ccf8.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/cuvs/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: b20f7f16-1395-49f3-a94c-accdae7ad6da
📥 Commits

Reviewing files that changed from the base of the PR and between 6cdea7e and 53c7b80.

📒 Files selected for processing (12)
  • .coderabbit.yaml
  • .github/workflows/pr.yaml
  • .gitignore
  • .pre-commit-config.yaml
  • README.md
  • cpp/doxygen/Doxyfile
  • cpp/doxygen/header.html
  • cpp/doxygen/main_page.md
  • dependencies.yaml
  • fern/README.md
  • fern/pages/c_guidelines.md
  • fern/pages/cpp_guidelines.md
💤 Files with no reviewable changes (6)
  • cpp/doxygen/main_page.md
  • dependencies.yaml
  • cpp/doxygen/header.html
  • .gitignore
  • .github/workflows/pr.yaml
  • .pre-commit-config.yaml

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 9 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contributor and developer guidance to describe how API references are generated from source comments and how to validate documentation.
    • Updated links to the contributor and developer guides.
    • Removed the Doxygen HTML header template and main-page description.
  • Chores
    • Updated review guidance and pull-request checks to reflect the current documentation locations and include matching Doxygen-related changes in Python test filters.

Walkthrough

The pull request updates contributor and review guidance to use Fern for API documentation. It removes Doxygen-related files and environment entries, changes CI path filters, and updates ignore and copyright-hook configuration.

Changes

Fern API documentation transition

Layer / File(s) Summary
Fern API authoring and review guidance
.coderabbit.yaml, README.md, fern/README.md, fern/pages/c_guidelines.md, fern/pages/cpp_guidelines.md
Review instructions and contributor links now target Fern. The guides describe Doxygen-style source comments consumed by the Fern API generator and replace Doxygen checks with Fern API-reference and documentation checks.
Documentation tooling and validation configuration
.github/workflows/pr.yaml, .gitignore, .pre-commit-config.yaml, cpp/doxygen/*, dependencies.yaml
The CI filters no longer exclude cpp/doxygen/**. The Doxygen header and main page are removed, the docs environment drops several includes, and Doxygen-related ignore entries are removed. The copyright hook configuration changes for github_link.py.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: imotov

Merge Risk: ⚪ Minimal · up to 53c7b

The PR removes obsolete documentation tooling while retaining Fern documentation support. No new user-facing or release risk is substantiated, so it is ready to merge after normal checks.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the removal of obsolete Doxygen and Sphinx documentation tooling, which is the main change.
Description check ✅ Passed The description explains the tooling removal, related documentation and CI updates, and the continued use of Doxygen-style comments and Sphinx-role parsing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@rapids-bot
rapids-bot Bot merged commit 973b7eb into NVIDIA:main Oct 8, 2026
320 of 327 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Unstructured Data Processing Oct 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants