Skip to content

Commit

Permalink
Docs: refactor and integrate into ROCm docs portal (ROCm#362)
Browse files Browse the repository at this point in the history
* pip-compile docs/requirements.txt

Signed-off-by: Peter Jun Park <[email protected]>

Add Sphinx docs config

Signed-off-by: Peter Jun Park <[email protected]>

Add Sphinx config

Signed-off-by: Peter Jun Park <[email protected]>

Update docs build config

Signed-off-by: Peter Jun Park <[email protected]>

* style(conf.py): Apply black formatting to docs/conf.py

Signed-off-by: Sam Wu <[email protected]>

* Update docs requirements

Signed-off-by: Peter Jun Park <[email protected]>

Update to rocm-docs-core 1.3.0

Signed-off-by: Peter Jun Park <[email protected]>

Update docs requirements

Signed-off-by: Peter Jun Park <[email protected]>

pip-compile requirements

Signed-off-by: Peter Jun Park <[email protected]>

bump rocm-docs-core to 1.5.0

bump rocm-docs-core to 1.4.1

Signed-off-by: Peter Jun Park <[email protected]>

* Add dependabot.yml and update CODEOWNERS

Signed-off-by: Peter Jun Park <[email protected]>

Update toc and conf

Signed-off-by: Peter Jun Park <[email protected]>

update dependabot

* Port docs to rocm-docs standard

Signed-off-by: Peter Jun Park <[email protected]>

Add toc and Diataxis cards

Signed-off-by: Peter Jun Park <[email protected]>

Add basic file structure

Signed-off-by: Peter Jun Park <[email protected]>

add glossary

Signed-off-by: Peter Jun Park <[email protected]>

add includes

Signed-off-by: Peter Jun Park <[email protected]>

Add license.rst

Signed-off-by: Peter Jun Park <[email protected]>

add compatible hw

Signed-off-by: Peter Jun Park <[email protected]>

fix spelling and license

Signed-off-by: Peter Jun Park <[email protected]>

clean up index

Signed-off-by: Peter Jun Park <[email protected]>

clean up installation guides

Signed-off-by: Peter Jun Park <[email protected]>

add basic usage (quickstart)

Signed-off-by: Peter Jun Park <[email protected]>

add ref to global options

update toc

Signed-off-by: Peter Jun Park <[email protected]>

modularize modes and global options

Signed-off-by: Peter Jun Park <[email protected]>

add profile mode

Signed-off-by: Peter Jun Park <[email protected]>

fixes

Signed-off-by: Peter Jun Park <[email protected]>

reorg and clean up

Signed-off-by: Peter Jun Park <[email protected]>

add dynamic omniperf version number in installation guide

Signed-off-by: Peter Jun Park <[email protected]>

add datatemplate

more reorg

Signed-off-by: Peter Jun Park <[email protected]>

clean up

Signed-off-by: Peter Jun Park <[email protected]>

reorg images

move profile mode

reorg

reorg

reorg more

fix formatting

fix headings

ref anchor mi2xx note

add extlinks

add extlinks

Signed-off-by: Peter Jun Park <[email protected]>

black format

fix formatting, anchors

Signed-off-by: Peter Jun Park <[email protected]>

reorg

fix words and formatting

Signed-off-by: Peter Jun Park <[email protected]>

formatting

Signed-off-by: Peter Jun Park <[email protected]>

same

reorg

format

fix formatting

fix toc

Signed-off-by: Peter Jun Park <[email protected]>

format

* impr internal linking and fix sphinx warnings

Signed-off-by: Peter Jun Park <[email protected]>

* add spellcheck/linting from rocm-docs-core

Signed-off-by: Peter Jun Park <[email protected]>

fix rst directives

satisfy spellcheck

fix more spelling

rm unused files

fix spelling and update wordlist

* bump rocm-docs-core to 1.6.0

Signed-off-by: Peter Jun Park <[email protected]>

* add fixes from @skyreflectedinmirrors and @lpaoletti

Signed-off-by: Peter Jun Park <[email protected]>

add references to toc

Signed-off-by: Peter Jun Park <[email protected]>

add more fixes

Signed-off-by: Peter Jun Park <[email protected]>

* add package manager install section

Signed-off-by: Peter Jun Park <[email protected]>

* add fixes

Signed-off-by: Peter Jun Park <[email protected]>

add metadata and fixes

Signed-off-by: Peter Jun Park <[email protected]>

add fixes

bump to 1.6.1

more fixes

fix fmt in profiling examples

Signed-off-by: Peter Jun Park <[email protected]>

add missing mem type table

Signed-off-by: Peter Jun Park <[email protected]>

fix formatting

fmt

* add custom css

Signed-off-by: Peter Jun Park <[email protected]>

fix css fs

* make images/figs click-to-expand

Signed-off-by: Peter Jun Park <[email protected]>

add missed image

update

fix link

* update documentation link in README

Signed-off-by: Peter Jun Park <[email protected]>

* formatting fixes

Signed-off-by: Peter Jun Park <[email protected]>

more formatting

* fix heading

Signed-off-by: Peter Jun Park <[email protected]>

* move archived docs

Signed-off-by: Peter Jun Park <[email protected]>

* exclude archived docs from docs build

Signed-off-by: Peter Jun Park <[email protected]>

* update archived docs workflow

Signed-off-by: Peter Jun Park <[email protected]>

move files

update archived docs workflow

Signed-off-by: Peter Jun Park <[email protected]>

fix version number

clean up workflow

workflow test

workflow test

another workflow test

* rm docs linting

Signed-off-by: Peter Jun Park <[email protected]>

* Apply cmake-format suggested changes

Signed-off-by: Sam Wu <[email protected]>

* Apply cmake-format

Signed-off-by: Sam Wu <[email protected]>

---------

Signed-off-by: Peter Jun Park <[email protected]>
Signed-off-by: Sam Wu <[email protected]>
Co-authored-by: Sam Wu <[email protected]>
Signed-off-by: xuchen-amd <[email protected]>
  • Loading branch information
2 people authored and xuchen-amd committed Oct 28, 2024
1 parent 2411aef commit aa25ae1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ updates:
open-pull-requests-limit: 10
schedule:
interval: "daily"
target-branch: "amd-staging"
target-branch: "dev"
labels:
- "documentation"
- "dependencies"
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
push:
branches: [ amd-mainline ]
paths:
- 'docs/archive/docs-2.x/**'
- 'docs/archive/docs-1.x/**'
- 'docs/archive/docs-2.x/**'
- 'docs/archive/docs-1.x/**'
- '.github/workflows/docs.yml'
Expand Down

0 comments on commit aa25ae1

Please sign in to comment.