6ec9526475
[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 >
2025-05-14 11:17:51 +05:30
bbe9eab53a
doc improvements for 1.0.0 ( #367 )
...
* correcting rocprofiler_configure
* Fix indexing order
* doc feedback
2025-04-24 17:05:22 +05:30
780b96ad3a
Remove SDK as beta from docs ( #351 )
2025-04-21 21:31:14 +05:30
379d760fc1
Fixing broken link ( #326 )
...
* fixing broken link
* added metadata information
---------
Co-authored-by: srawat <120587655+SwRaw@users.noreply.github.com >
Co-authored-by: Bhardwaj, Gopesh <Gopesh.Bhardwaj@amd.com >
2025-04-03 18:12:34 +05:30
31b8f61c8e
Documentation updates ( #236 )
...
* Documentation updates
* formatting
* Update using-rocprofv3.rst
* Update counter_collection_services.md
---------
Co-authored-by: srawat <120587655+SwRaw@users.noreply.github.com >
2025-02-28 10:10:26 +05:30
cdf22eba7d
Adding pc sampling how to guide ( #160 )
...
* Adding pc sampling how to guide
* doc update
* Fixing indentation
* updating index
* udpating doc
* updating doc
* Added field information
* Fixing Formatting
* fix formatting error
* Added json format for pc sampling
* feedback resolved
* formatting for text
* PC Sampling API doc
* Reformatted
* Note for shared systems
* update docs
* correcting relative path for cross-referencing
---------
Co-authored-by: vlaindic_amdeng <vladimir.indic@amd.com >
2025-02-10 20:33:05 -06:00
7821657d65
SWDEV-510794 Adding MPI usage with rocprofv3 ( #183 )
...
* swdev-510794 Adding MPI usage with rocprofv3
* update doc
* Fixed build issues
* updating doc
* doc update
* Fixed Typos
* csv format
* change format to shell
2025-02-07 12:01:31 +05:30
12508b9521
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
2025-02-05 11:04:24 -06:00
73e7f8cfb1
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 >
2025-01-22 11:34:21 -06:00
4204042ac6
Refactor API reference docs ( #1125 )
...
* Refactor API reference docs
* refactor API ref docs
* corrections
* consistent naming
* updates
* Update CHANGELOG.md
* improving SEO
* improving SEO
* Update using-rocprofv3.rst
* Update counter_collection_services.md
* Update using-rocprofv3.rst
* Fixing doc build errors
* changelogs and some formatting issues
---------
Co-authored-by: Gopesh Bhardwaj <gopesh.bhardwaj@amd.com >
2024-10-30 19:39:08 +05:30
69caa62b60
rocprofv3 doc updates ( #982 )
...
* updating rocprofv3
* using rocprofv3
* review updates
* naming standardization
* Update source/docs/how-to/using-rocprofv3.rst
Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com >
* review comments
* adding API references
* kernel filtering
* Remove Sphinx warn as error
To bypass false warning for linking between rst and md
* remove unused (duplicate) refs in _toc.yml.in
---------
Co-authored-by: Gopesh Bhardwaj <gopesh.bhardwaj@amd.com >
Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com >
Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com >
Co-authored-by: Peter Jun Park <peter.park@amd.com >
2024-08-02 14:08:04 -05:00
785cc39c16
gobhardw/docs refactor ( #975 )
...
* refactor docs
* Fixing docs build
* merging 967
* Improving readability with table usage
* review changes
* compilation fix
* README links
---------
Co-authored-by: srawat <120587655+SwRaw@users.noreply.github.com >
2024-07-18 12:58:20 +05:30
Kandula, Venkateshwar reddy
Bhardwaj, Gopesh
Rawat, Swati
srawat