Skip to content

[REVIEW] Remove obsolete Doxygen and Sphinx documentation tooling - #2649

Open
bdice wants to merge 1 commit into
NVIDIA:mainfrom
bdice:remove-legacy-docs-tooling
Open

bdice wants to merge 1 commit 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
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

None yet

Development

Successfully merging this pull request may close these issues.

2 participants