Skip to content

Conversation

@pmaybank
Copy link
Contributor

Proposed changes

- Configure Doxygen for 8-core parallel processing
- switch GENERATE_HTML from YES to NO in Doxyfile
- Add CMake documentation infrastructure with auto Python venv management
- switch off doxygen html generation in Sphinx conf.py
- Enable streamlined docs build: cmake --build . --target docs

Please describe the motivation behind the pull request, whether it enables a new feature or fixes a bug. If there are associated pull requests or issues, please link them to the pull request.

Checklist

Please put an x into the boxes that apply. You can also fill these out after creating the PR. If you're not sure, please don't hesitate to ask.

  • I have added tests relevant to the introduced functionality, and the unit tests are passing locally
  • I have added the test to REGRESSION_TESTS list defined at the top of CMakeLists.txt in tests/CMakeLists.txt, IF the test takes more than 30 seconds to run.
  • I have added inline documentation which enables the maintainers with understanding the motivation
  • I have removed the stale documentation which is no longer relevant after this pull request
  • (If this change is user-facing) I have added release notes which provide the end users with a brief summary of the improvement from this pull request
  • I have run clang-format on all changed files
  • Any dependent changes have been merged

Discussion

If this is a relatively large or complex change, feel free to start a discussion by explaining why you chose the solution you did and what alternatives you considered

vidyasagar-amd and others added 13 commits October 2, 2025 10:53
GH-2368 Minor edits

GH-2368 Adding missing READMEs and standardization.

resolving readme updates

GH-2368 Minor improvements to documentation.

Improving some readmes.

Further improvement for readmes.

Cleaned up the documentation in 'client_example' (#2468)

Update for PR

Update ACRONYMS.md to remove trivial terms

Update ACRONYMS.md to provide detailed explanations for BF16 and BF8 formats

Apply suggestion from @spolifroni-amd

Co-authored-by: spolifroni-amd <[email protected]>

Apply suggestion from @spolifroni-amd

Co-authored-by: spolifroni-amd <[email protected]>

Update README.md to clarify CK Tile API description and remove outdated references to the Tile Engine.

revise 37_transpose readme

revise 36_copy readme

Remove references to the Tile Engine in README files for 19_gemm_multi_d and 35_batched_transpose, and update distribution links for clarity.

Remove references to the Tile Engine in multiple README files and update distribution links for consistency and clarity.

Remove references to the Tile Engine in README files across multiple examples
GH-2368 Minor edits

GH-2368 Adding missing READMEs and standardization.

resolving readme updates

GH-2368 Minor improvements to documentation.

Improving some readmes.

Further improvement for readmes.

Cleaned up the documentation in 'client_example' (#2468)

Update for PR

Update ACRONYMS.md to remove trivial terms

Update ACRONYMS.md to provide detailed explanations for BF16 and BF8 formats

Apply suggestion from @spolifroni-amd

Co-authored-by: spolifroni-amd <[email protected]>

Apply suggestion from @spolifroni-amd

Co-authored-by: spolifroni-amd <[email protected]>

Update README.md to clarify CK Tile API description and remove outdated references to the Tile Engine.

revise 37_transpose readme

revise 36_copy readme

Remove references to the Tile Engine in README files for 19_gemm_multi_d and 35_batched_transpose, and update distribution links for clarity.

Remove references to the Tile Engine in multiple README files and update distribution links for consistency and clarity.

Remove references to the Tile Engine in README files across multiple examples

Refine README files by removing outdated references to the Tile Engine
- Configure Doxygen for 8-core parallel processing
- switch GENERATE_HTML from YES to NO in Doxyfile
- Add CMake documentation infrastructure with auto Python venv management
- switch off doxygen html generation in Sphinx conf.py
- Enable streamlined docs build: cmake --build . --target docs
@pmaybank pmaybank requested review from a team and tenpercent as code owners October 14, 2025 11:06
Copy link
Contributor

@spolifroni-amd spolifroni-amd left a comment

Choose a reason for hiding this comment

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

Changes to conf.py and doxygen need to be rolled back. Thanks.

@vidyasagar-amd vidyasagar-amd force-pushed the documentation-cleanup branch 3 times, most recently from 10b1b92 to ad15dfc Compare October 16, 2025 01:39
Base automatically changed from documentation-cleanup to develop October 16, 2025 10:11
@pmaybank
Copy link
Contributor Author

pmaybank commented Oct 20, 2025

Changes to conf.py and doxygen need to be rolled back. Thanks.

I have now addressed this comment and the changes have been pushed to a newly created branch, with a new PR - #3060

@pmaybank pmaybank closed this Oct 20, 2025
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.

6 participants