CK: removed the api reference#3571
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request removes the CK/CK Tile API reference from the documentation, as it's of limited use to users due to the library's template-only nature. The changes involve removing API reference links, disabling Doxygen in the build configuration, and fixing various documentation issues.
Changes:
- Removed API reference links and documentation sections from multiple files
- Disabled Doxygen processing in conf.py by removing
run_doxygen()andenable_api_reference()calls - Updated package dependencies in requirements.txt, removing Doxygen-related packages (doxysphinx, matplotlib, etc.)
- Fixed documentation issues including typos, incorrect cross-references, and formatting problems
Reviewed changes
Copilot reviewed 16 out of 18 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/sphinx/requirements.txt | Removed Doxygen-related dependencies and updated package versions |
| docs/sphinx/_toc.yml.in | Removed API reference entries and simplified entry titles |
| docs/reference/Composable-Kernel-wrapper.rst | Removed Doxygen-generated API documentation sections |
| docs/reference/Composable-Kernel-Glossary.rst | Fixed typos and incorrect term references |
| docs/index.rst | Removed API reference links from main documentation page |
| docs/conf.py | Disabled Doxygen processing |
| docs/conceptual/ck_tile/tile_window.rst | Added blank lines for formatting |
| docs/conceptual/ck_tile/tile_distribution.rst | Fixed reference label from ck_tile_distribution to ck_tile_tile_distribution |
| docs/conceptual/ck_tile/lds_index_swapping.rst | Fixed typo, converted code blocks to math blocks |
| docs/conceptual/ck_tile/introduction_motivation.rst | Fixed cross-reference to use correct label |
| docs/conceptual/ck_tile/coordinate_movement.rst | Fixed cross-reference from ck_tile_tile_distribution to ck_tile_distribution |
| docs/conceptual/ck_tile/convolution_example.rst | Removed duplicate image, fixed cross-references |
| docs/conceptual/ck_tile/buffer_views.rst | Added overview section |
| docs/conceptual/ck_tile/adaptors.rst | Fixed heading placement |
| docs/conceptual/ck_tile/MERMAID_DIAGRAMS.md | Removed file documenting diagram management |
| docs/conceptual/ck_tile/CK-tile-index.rst | Updated title and structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,4 +1,4 @@ | |||
| .. _ck_tile_distribution: | |||
| .. _ck_tile_tile_distribution: | |||
There was a problem hiding this comment.
The reference label has been changed from ck_tile_distribution to ck_tile_tile_distribution, introducing a redundant 'tile' prefix. This creates inconsistency with other references in the codebase that use ck_tile_distribution.
| .. _ck_tile_tile_distribution: | |
| .. _ck_tile_distribution: |
There was a problem hiding this comment.
This is ok because ck_tile is the scope and tile_distribution is the concept within that scope.
There was a problem hiding this comment.
I don't believe that the ck_tile_distribution and ck_tile_window "anchors" exist anymore.
I believe you need to
- change all
ck_tile_distributionreferences tock_tile_tile_distributionand - change all
ck_tile_windowreferences tock_tile_tile_window
Update: I discussed this with @spolifroni-amd, and given that the current PR resolves existing doc build issues we can defer this to a later PR.
Proposed changes
The CK team has asked that the CK/CK Tile API reference be removed because it's of limited use. The CK/CK Tile is a template-only library that also contains example- and application-specific content that isn't of use to a user.
Removing the reference involved removing the links to the API reference, and also changing conf.py and requirements.in so doxygen no longer runs. This should also make doc builds substantially faster.
I also took the opportunity to fix some issues with the CK Tile doc and the glossary, and change the way the CK Tile doc was linked.