Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation update for Read the Docs
Updated docs to use the ROCm standard (#418) * Convert Doxygen doc to Sphinx doc breathe needs to be patched in order to correctly look up the functions. The doc can still be generated but with generated errors within the doc. * Update README.md for Sphinx doc * Update README.md for Sphinx doc * Add svg images to regenerate png * Add comments to distinguish images generated from SVG * Order and organize doc * Remove the mention to CUB * Correct typo, improve style * Add examples to iterators * Explicit dependencies versions for building doc * Correct typos Signed-off-by: v01dxyz <[email protected]> * Remove SVG image directory * Re-enable preprocessing for doxygen `__host__` and `__device__` function attributes are shown in the docs. * Re-enable Doxygen to expand all the macros instead of only the predefined ones. * Add cuda / hip attributes to `cpp_id_attributes` in sphinx. This fixes it erroring out on these attributes. * Add `rocprim::` suffix to all functions/classes name references in the rst docs. They were not working previously because the namespace macros were not expanded by doxygen. * Fix documentation of template overloaded methods with doxygen groups Use doxygen groups as a workaround for breathe failing to find methods that have complex template names, or both templated and non templated overloads. non-resolved problem: The `ropcrim::` prefix is not appended to the object names, contrary to the ones generated by the other directives. * Simplify macros for Doxygen * keep only one pre-defined variable to indicate Doxygen preprocessor * isolate macro definitions for Doxygen (only one ifndef instead of one per problematic macro) * Organize conf.py Gather the html options. * Correct typo * Clean Doxyfile Remove commented declarations * Render function parameters as a HTML list Ameliorate how the function signatures are rendered by using HTML list instead of one big single line signature. It is a hack since it mixes span elements with div elements side by side which is not good HTML. Furthermore, this translator would possibly need maintenance if Sphinx introduces breaking changes to the base Translator. * Simplify custom CSS * Remove documentation images Those two images were not particularly relevant and well polished. There were a logo and a draft schema to visualise the different GPU scopes. * Revert deletion of DOXYGEN_SHOULD_SKIP_THIS * Populate doxygen groups for intrinsics * Correct typo Delete duplicate title for a section that was displaced to another file * Rename ops directories * Rename filename/title for summary of the ops * Fixed rebase in config.hpp * Updated docs to the ROCm standard * Updated style and copyright date * Removed docs from top-level gitignore * Removed redundant requirements.txt * Updated CHANGELOG.md * Updated gitignore * Updated Changelog.md * Rebase fix * Updated docs/.gitignore * Added Acknowledgements --------- Signed-off-by: v01dxyz <[email protected]> Co-authored-by: v01dxyz <[email protected]> Co-authored-by: Gergely Meszaros <[email protected]> Add dependabot config and pin rocm-docs-core (#420) Update documentation requirements (#429) Co-authored-by: samjwu <[email protected]> Fix sphinx error for reduce by key entry (#441) * docs(reduce): fix sphinx error for reduce by key entry * docs(reduce): document 'no side-effect'-requirement for reduce by key rocm-docs-core==0.13.4
- Loading branch information