Skip to content

Build Docs fix#2982

Merged
ptrendx merged 3 commits into
NVIDIA:mainfrom
vthumbe1503:doxygen_fix
May 12, 2026
Merged

Build Docs fix#2982
ptrendx merged 3 commits into
NVIDIA:mainfrom
vthumbe1503:doxygen_fix

Conversation

@vthumbe1503
Copy link
Copy Markdown
Collaborator

Description

Please include a brief summary of the changes, relevant motivation and context.

Fixes # (issue)

Type of change

  • Documentation change (change only to the documentation, either a fix or a new content)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Infra/Build change
  • Code refactoring

Changes

Please list the changes introduced in this PR:

  • Change A
  • Change B

Checklist:

  • I have read and followed the contributing guidelines
  • The functionality is complete
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Signed-off-by: Varun Thumbe <vthumbe@nvidia.com>
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 12, 2026

Greptile Summary

This PR fixes documentation build issues by removing deprecated Doxygen configuration options and correcting Doxygen/Sphinx doc-comment syntax across the C headers and RST API reference.

  • docs/Doxyfile: Strips 9 options (OUTPUT_TEXT_DIRECTION, TCL_SUBST, COLS_IN_ALPHA_INDEX, HTML_TIMESTAMP, FORMULA_TRANSPARENT, LATEX_SOURCE_CODE, LATEX_TIMESTAMP, RTF_SOURCE_CODE, DOCBOOK_PROGRAMLISTING) that were removed in newer Doxygen versions and cause parse errors or warnings.
  • docs/api/pytorch.rst: Switches the autocast directive from autoapifunction to autoapiclass with constructor signature, matching the pattern used for all other class entries in the file.
  • gemm.h / transformer_engine.h: Corrects \\param[in/out] to \\param[in,out], moves the nvte_grouped_gemm doc block to sit directly above its function declaration, fixes tensor-count description mismatches, and fills in previously missing parameter docs for the two discrete-variant grouped-GEMM functions.

Confidence Score: 5/5

All changes are limited to documentation files and doc-comment headers; no runtime logic is modified.

Every change either removes known-deprecated Doxygen config keys, fixes Doxygen tag syntax, corrects a misplaced comment block, or updates an RST directive type. None of the modifications touch compiled code paths, and the patterns introduced are already established in the surrounding file context.

No files require special attention.

Important Files Changed

Filename Overview
docs/Doxyfile Removes 9 deprecated Doxygen configuration options that no longer exist in newer Doxygen releases and cause build warnings/errors.
docs/api/pytorch.rst Corrects the documentation directive for autocast from autoapifunction to autoapiclass with constructor signature, consistent with all other class entries in this file.
transformer_engine/common/include/transformer_engine/gemm.h Fixes Doxygen syntax [in/out] to [in,out], relocates the misplaced nvte_grouped_gemm doc comment above its function declaration, corrects tensor-length descriptions, and adds previously missing parameter docs for two discrete-variant functions.
transformer_engine/common/include/transformer_engine/transformer_engine.h Fixes four occurrences of the invalid Doxygen tag [in/out] to the correct [in,out] form across tensor and quantization config parameter docs.

Reviews (3): Last reviewed commit: "class doc fix" | Re-trigger Greptile

Signed-off-by: Varun Thumbe <vthumbe@nvidia.com>
ptrendx
ptrendx previously approved these changes May 12, 2026
Signed-off-by: Varun Thumbe <vthumbe@nvidia.com>
Copy link
Copy Markdown
Collaborator

@jberchtold-nvidia jberchtold-nvidia left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@ptrendx ptrendx merged commit f0ab81d into NVIDIA:main May 12, 2026
10 of 12 checks passed
faradawn pushed a commit to faradawn/TransformerEngine that referenced this pull request May 14, 2026
* Build Docs fix

Signed-off-by: Varun Thumbe <vthumbe@nvidia.com>

* fix doxygen warnings

Signed-off-by: Varun Thumbe <vthumbe@nvidia.com>

* class doc fix

Signed-off-by: Varun Thumbe <vthumbe@nvidia.com>

---------

Signed-off-by: Varun Thumbe <vthumbe@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants