abf3f869e9
Making ROCTx API doxygen generated document more readable ( #385 )
...
* Making ROCTx API doxygen generated document more readable
* fixing build
* Fix linking errors
* Fixing header
* Fixing Topics and Types
* doxygen configuration fixes
* Fixing build
* Fix unnecessory doc parsing warnings
* formatting and linting fixes
* rebasing SDK modular PR
* Fixing missing line
* Fixing ROCtx documentation after merge
* Removing flake changes
* changed back WARN_IF_DOC_ERROR to Yes
[ROCm/rocprofiler-sdk commit: b48fa532bc
2025-05-22 18:08:55 -05:00
89fbdeb196
[docs] Improve readability of ROCprofiler-SDK API library documentation ( #359 )
...
* Use custom .rst to make api doc more readable.
* Update index.rst
* Misc docs updates
- doxygen source code fixes
- updated doxygen files
- fixed conf.py (does not generate code in source tree)
* Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst
Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com >
* Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst
Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com >
* Update source/docs/api-reference/rocprofiler-sdk_api/modules.rst
Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com >
* Update source/docs/api-reference/rocprofiler-sdk_api/global_data_structures_topics_files.rst
Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com >
* Duplicate
* test warnings
* Update CMakeLists.txt
* Update rocprofiler-sdk.dox.in
* Update update-docs.sh
* fix docs build failures by -q -T flags.
* set warn_as_error to NO.
* test -W to suppress warnings.
* remove -q flag from make.
* reduce dot graph depth to 100
* Update custom docs target
- docs target is now no longer part of the dependency list for the all target
- installation of docs requires explicitly building the docs target (i.e. OPTIONAL install of _build/html/ folder)
* add quit and trace mode back.
* increase DOT_GRAPH_MAX_NODES to 500 back.
* Format.
---------
Co-authored-by: Venkateshwar Reddy Kandula <vkandula@amd.com >
Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com >
Co-authored-by: Bhardwaj, Gopesh <Gopesh.Bhardwaj@amd.com >
Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com >
Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com >
[ROCm/rocprofiler-sdk commit: 6ec9526475
2025-05-14 11:17:51 +05:30
8778237298
doc improvements for 1.0.0 part 2 ( #330 )
...
* update installation steps
* Github Issue #50 Adding README's for samples
* Making name change to ROCprofiler-SDK for consistency
* Fix HIP trace documentation
* Fix HSA trace in docs
* Fix kernel trace in docs
* Fixing memory copy and memory allocation traces
* runtime trace and sys trace doc update
* Fix scratch memory doc
* kernel naming and filtering options
* Adding collection period in docs
* Perfetto configs update
* summary output file
* kernel trace format fix
* update CHANGELOG
* Agent index doc update
* rocm-smi output
* group by queue option
* Updated --group-by-queue description
* perfetto visualization
---------
Co-authored-by: Ian Trowbridge <Ian.Trowbridge@amd.com >
[ROCm/rocprofiler-sdk commit: ca7cce9e81
2025-04-15 13:30:07 -07:00
a8a82d7263
Adding ROCTx usage doc ( #159 )
...
* Adding Roctx usage doc
* updated CHANGELOG
* dpc update
* Fixing Related Pages issue
* updating doc
* updating docs
* Adding Resource naming section
* Fixed Formatting
* format fix
* format fix
* Fixing build due to incorrect indentation
[ROCm/rocprofiler-sdk commit: 12508b9521
2025-02-05 11:04:24 -06:00
04ace57589
ROCTx Documentation ( #29 )
...
* Add roctx doc
* Add roctx doxyfile input
* Update links and toc
* Build doxysphinx for both doxygen files
* Update scripts
* Generate roctx doxygen files
* Change doxygen path
to allow for 2 doxyfiles
* Make doxygen dir for script
* Call make _doxygen dir with p flag
* Create _doxygen dir in workfllow
* Create doc dirs for doxygen
* Run update docs as sudo
* Fix typo in mkdir command
* Include graphviz for dot
* Install dot for docs CI
* Install dot as sudo due to permission denied
* Install doxygen via sudo
* Install doxysphinx
* Add postcheckout step to RTD to config and gen doxygen docs
* On RTD, update doxygen after creating env
* update docs.yml
* update docs.yml
* fixing build-docs-from-source
* Fixing build docs from source
* update docs.yml
* trying to fix readthedocs
* trying to fix readthedocs
* update docs.yml
* improve mainpage documentation
* update docs
* clang-format fix
---------
Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com >
Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com >
[ROCm/rocprofiler-sdk commit: 73e7f8cfb1
2025-01-22 11:34:21 -06:00
Bhardwaj, Gopesh
Kandula, Venkateshwar reddy