Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Omnitrace docs refactoring #353

Merged
merged 67 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
508b8c6
Add Sphinx and Read the Docs configs
peterjunpark Jun 12, 2024
6fe1adb
Add documentation workflow configurations
peterjunpark Jun 18, 2024
a4f47c3
Changed macros verbprintf and verbprintf_bare so they write to stdout…
ajanicijamd Jun 14, 2024
71362da
Removing static version asserts. (#347)
dgaliffiAMD Jun 15, 2024
be9ff7a
Check for an empty vector before popping (#350)
dgaliffiAMD Jun 19, 2024
0651196
Add release links to installation.md (#351)
jrmadsen Jun 19, 2024
751c289
Initial infrastructure rework for Omnitrace refactoring and a rewrite…
amd-jnovotny Jun 21, 2024
d6ae576
Add files in conceptual section, along with images and infrastructure…
amd-jnovotny Jun 21, 2024
1678b63
Formatting and style fixes for files in conceptual directory
amd-jnovotny Jun 21, 2024
59a7913
Add quick start install guide and fix spelling errors in other files
amd-jnovotny Jun 23, 2024
04d205c
Add install document and fix code tags. Infrastructure changes
amd-jnovotny Jun 24, 2024
0b50797
Add two how-to guides along with infra changes and spelling fixes
amd-jnovotny Jun 25, 2024
ee90a29
Add two new how to files and fix errors in the last commit
amd-jnovotny Jun 25, 2024
223c580
Fix spelling mistakes
amd-jnovotny Jun 25, 2024
744a847
Add new how to file on causal profiling and infra changes.
amd-jnovotny Jun 26, 2024
6f1eaa7
Add how to file on interpreting Omnitrace output, fixes, and images
amd-jnovotny Jun 27, 2024
b87f406
Add remaining how-to guides and reference materials along with fixes …
amd-jnovotny Jun 28, 2024
c8393f6
Add YouTube file and fix spelling and formatting
amd-jnovotny Jun 28, 2024
bf7a0d9
Fix a few loose ends and add link to license page
amd-jnovotny Jun 28, 2024
ee8a4c3
Add Sphinx and Doxygen infrastructure and some additional corrections
amd-jnovotny Jun 28, 2024
05b6dd8
Update rocm-docs-core
samjwu Jun 28, 2024
5508e30
Fix Doxyfile
samjwu Jun 28, 2024
9cb7590
Fix path to API header files
amd-jnovotny Jun 28, 2024
fc44f2c
Run doxysphinx in conf.py
samjwu Jun 28, 2024
e202f9d
Add back custom css for doxygen
samjwu Jun 28, 2024
39d8782
Remove doxygenlayout
samjwu Jun 28, 2024
02bf38e
Add api to toc
samjwu Jun 28, 2024
19a9053
Update Doxyfile
samjwu Jul 2, 2024
2592b80
Proofreading edits and other changes
amd-jnovotny Jul 1, 2024
5199fe0
Add .gitignore for Doxygen and remove deprecated words and typos
amd-jnovotny Jul 2, 2024
315eedf
Fix one additional typo
amd-jnovotny Jul 2, 2024
c98e0c2
Turn off dot
samjwu Jul 2, 2024
2079d9c
Update doxyfile strip from path
samjwu Jul 2, 2024
14b9ea3
Workflow, submodules, and thread info Updates (#352)
jrmadsen Jun 20, 2024
21453eb
ROCm 6.1 Installers (#349)
dgaliffiAMD Jun 21, 2024
b9a4330
Update timemory submodule (#354)
jrmadsen Jun 26, 2024
bab88d6
Build omnitrace-rt library (#355)
jrmadsen Jun 27, 2024
b0dee06
Executables append omnitrace library directory to LD_LIBRARY_PATH (#356)
jrmadsen Jul 2, 2024
5c36453
Fix a few typos and formatting issues
amd-jnovotny Jul 3, 2024
e60bc06
Additional fixes and minor formatting changes.
amd-jnovotny Jul 3, 2024
3bda836
More fixes and minor formatting changes.
amd-jnovotny Jul 3, 2024
98e2c34
Complete second proofreading with fixes and minor formatting changes.
amd-jnovotny Jul 3, 2024
7178fa8
Make changes to table of contents and disable linting
amd-jnovotny Jul 3, 2024
ebace99
Update links in the README doc to reflect the new structure.
amd-jnovotny Jul 3, 2024
6f8745b
Align intro on the Omnitrace index page with the first paragraph of t…
amd-jnovotny Jul 4, 2024
90bc20d
Changes and edits based on review comments
amd-jnovotny Jul 11, 2024
52b9105
Additional changes and edits based on external review
amd-jnovotny Jul 15, 2024
2786bab
Additional updates and changes from the external review of Omnitrace
amd-jnovotny Jul 16, 2024
81cd754
Additional changes based on the external review
amd-jnovotny Jul 17, 2024
0f82562
New round of edits based on the external review
amd-jnovotny Jul 18, 2024
aed224c
Additional edits based on the external review
amd-jnovotny Jul 18, 2024
b3bea50
Changes to address comments from the internal review
amd-jnovotny Jul 22, 2024
9e21f10
Correct to the RHEL SELinux note in the troubleshooting guide
amd-jnovotny Jul 22, 2024
1f058a8
One additional change to the development guide code example
amd-jnovotny Jul 23, 2024
3f914ed
Move troubleshooting to post-install of install.rst and other minor e…
amd-jnovotny Jul 24, 2024
c93e7eb
Remove troubleshooting page and modify new post-install troubleshooti…
amd-jnovotny Jul 24, 2024
4c9b1d0
Refactor the how Omnitrace works page into seperate topics and redo i…
amd-jnovotny Jul 25, 2024
2d02965
API ToC changes
amd-jnovotny Jul 25, 2024
f10f3ef
Additional API and ToC changes
amd-jnovotny Jul 25, 2024
6ad6f36
Back out API and ToC changes and update requirements.txt
amd-jnovotny Jul 25, 2024
1599171
Additional API and ToC changes
amd-jnovotny Jul 25, 2024
1a11ab6
Add commit for signing purposes
amd-jnovotny Jul 29, 2024
048072d
Add ElfUtils and BinUtils Download URL Overrides (#358)
dgaliffiAMD Jul 10, 2024
fdab529
Remove Ubuntu 18.04 and SUSE 15.2
dgaliffiAMD Jul 11, 2024
e7a3039
Update checkout action to v4
dgaliffiAMD Jul 11, 2024
3477620
Add `docs/**` to `paths-ignore`
dgaliffiAMD Jul 11, 2024
a54c3f9
Modified submodules dyninst and timemory. (#361)
ajanicijamd Jul 29, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .clang-tidy
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ performance-*,\
readability-*,\
-readability-function-size,\
-readability-identifier-naming,\
-readability-identifier-length,\
-readability-implicit-bool-cast,\
-readability-inconsistent-declaration-parameter-name,\
-readability-named-parameter,\
Expand Down
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
docs/* @ROCm/rocm-documentation
*.md @ROCm/rocm-documentation
*.rst @ROCm/rocm-documentation
.readthedocs.yaml @ROCm/rocm-documentation
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,14 @@ updates:
directory: "/" # Location of package manifests
schedule:
interval: "weekly"

- package-ecosystem: "pip" # See documentation for possible values
directory: "/docs/sphinx" # Location of package manifests
open-pull-requests-limit: 10
schedule:
interval: "daily"
labels:
- "documentation"
- "dependencies"
reviewers:
- "samjwu"
20 changes: 0 additions & 20 deletions .github/workflows/containers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,10 @@ jobs:
fail-fast: false
matrix:
include:
- distro: "ubuntu"
version: "18.04"
- distro: "ubuntu"
version: "20.04"
- distro: "ubuntu"
version: "22.04"
- distro: "opensuse"
version: "15.2"
- distro: "opensuse"
version: "15.3"
- distro: "opensuse"
Expand Down Expand Up @@ -86,22 +82,6 @@ jobs:
fail-fast: false
matrix:
include:
# ubuntu 18.04
- os-distro: "ubuntu"
os-version: "18.04"
rocm-version: "0.0"
- os-distro: "ubuntu"
os-version: "18.04"
rocm-version: "4.5"
- os-distro: "ubuntu"
os-version: "18.04"
rocm-version: "5.0"
- os-distro: "ubuntu"
os-version: "18.04"
rocm-version: "5.1"
- os-distro: "ubuntu"
os-version: "18.04"
rocm-version: "5.2"
# ubuntu 20.04
- os-distro: "ubuntu"
os-version: "20.04"
Expand Down
29 changes: 25 additions & 4 deletions .github/workflows/cpack.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
- v*
paths-ignore:
- '*.md'
- 'docs/**'
- 'source/docs/**'
pull_request:
branches: [main]
Expand All @@ -31,10 +32,6 @@ jobs:
fail-fast: false
matrix:
include:
# ubuntu 18.04
- os-distro: "ubuntu"
os-version: "18.04"
rocm-version: "0.0"
# ubuntu 20.04
- os-distro: "ubuntu"
os-version: "20.04"
Expand All @@ -54,6 +51,9 @@ jobs:
- os-distro: "ubuntu"
os-version: "20.04"
rocm-version: "6.0"
- os-distro: "ubuntu"
os-version: "20.04"
rocm-version: "6.1"
# ubuntu 22.04
- os-distro: "ubuntu"
os-version: "22.04"
Expand All @@ -73,6 +73,9 @@ jobs:
- os-distro: "ubuntu"
os-version: "22.04"
rocm-version: "6.0"
- os-distro: "ubuntu"
os-version: "22.04"
rocm-version: "6.1"
# opensuse 15.3
- os-distro: "opensuse"
os-version: "15.3"
Expand Down Expand Up @@ -114,13 +117,19 @@ jobs:
- os-distro: "opensuse"
os-version: "15.4"
rocm-version: "6.0"
- os-distro: "opensuse"
os-version: "15.4"
rocm-version: "6.1"
# opensuse 15.5
- os-distro: "opensuse"
os-version: "15.5"
rocm-version: "0.0"
- os-distro: "opensuse"
os-version: "15.5"
rocm-version: "6.0"
- os-distro: "opensuse"
os-version: "15.5"
rocm-version: "6.1"
# RHEL 8.7
- os-distro: "rhel"
os-version: "8.7"
Expand Down Expand Up @@ -153,13 +162,19 @@ jobs:
- os-distro: "rhel"
os-version: "8.8"
rocm-version: "6.0"
- os-distro: "rhel"
os-version: "8.8"
rocm-version: "6.1"
# RHEL 8.9
- os-distro: "rhel"
os-version: "8.9"
rocm-version: "0.0"
- os-distro: "rhel"
os-version: "8.9"
rocm-version: "6.0"
- os-distro: "rhel"
os-version: "8.9"
rocm-version: "6.1"
# RHEL 9.1
- os-distro: "rhel"
os-version: "9.1"
Expand All @@ -183,13 +198,19 @@ jobs:
- os-distro: "rhel"
os-version: "9.2"
rocm-version: "6.0"
- os-distro: "rhel"
os-version: "9.2"
rocm-version: "6.1"
# RHEL 9.3
- os-distro: "rhel"
os-version: "9.3"
rocm-version: "0.0"
- os-distro: "rhel"
os-version: "9.3"
rocm-version: "6.0"
- os-distro: "rhel"
os-version: "9.3"
rocm-version: "6.1"

steps:
- name: Free Disk Space
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
conda activate omnitrace-docs
./update-docs.sh
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
uses: actions/upload-pages-artifact@v3
with:
path: ./docs

Expand All @@ -67,4 +67,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v4
6 changes: 4 additions & 2 deletions .github/workflows/opensuse.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
branches: [ main, develop ]
paths-ignore:
- '*.md'
- 'docs/**'
- 'source/docs/**'
- 'source/python/gui/**'
- '.github/workflows/docs.yml'
Expand All @@ -17,6 +18,7 @@ on:
branches: [ main, develop ]
paths-ignore:
- '*.md'
- 'docs/**'
- 'source/docs/**'
- 'source/python/gui/**'
- '.github/workflows/docs.yml'
Expand All @@ -42,11 +44,11 @@ jobs:
fail-fast: false
matrix:
compiler: ['g++']
os-release: [ '15.2', '15.3', '15.4' ]
os-release: [ '15.3', '15.4' ]
build-type: ['Release']

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Install Packages
timeout-minutes: 25
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/redhat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
branches: [ main, develop ]
paths-ignore:
- '*.md'
- 'docs/**'
- 'source/docs/**'
- 'source/python/gui/**'
- '.github/workflows/docs.yml'
Expand All @@ -17,6 +18,7 @@ on:
branches: [ main, develop ]
paths-ignore:
- '*.md'
- 'docs/**'
- 'source/docs/**'
- 'source/python/gui/**'
- '.github/workflows/docs.yml'
Expand Down
Loading
Loading