Repository navigation
Remove obsolete Doxygen and Sphinx documentation tooling - #2649
Conversation
| 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. | ||
|
|
There was a problem hiding this comment.
I'm fine with keeping or removing this sentence. Up to reviewers.
| 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. |
| 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. | ||
|
|
dantegd
left a comment
There was a problem hiding this comment.
Cleanup looks good to me
|
/merge |
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes. ⚙️ Run configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (12)
💤 Files with no reviewable changes (6)
Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 9 remain after this review. 📝 SummarySummary by CodeRabbit
WalkthroughThe 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. ChangesFern API documentation transition
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to 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)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
cuVS builds its documentation with Fern, whose API generator reads source files directly rather than consuming Doxygen XML.
cpp/doxygen/assets and stale CI, lint, and ignore rules.Doxygen-style source comments and Sphinx-role parsing remain in use and are preserved. No public API or generated API content changes.
Supersedes #2609.