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

Updated docs to use the ROCm standard #236

Merged
merged 5 commits into from
Mar 31, 2023
Merged

Conversation

mfep
Copy link
Contributor

@mfep mfep commented Mar 28, 2023

  • Updated HTML documentation generation to match the structure of hipBLAS/docs
    • Using the rocm-docs-core template
    • Additionally using exhale to automatically generate the API documentation

@saadrahim saadrahim merged commit 168b76b into ROCm:develop Mar 31, 2023
@mfep mfep deleted the consolidate-docs branch April 3, 2023 07:46
stanleytsang-amd added a commit that referenced this pull request May 31, 2023
* Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

* Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

* Fix dependabot file structure (#238)

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

* Update dependabot config (#239)

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

* Update version string (#242)

* Update documentation requirements - replaces exhale with doxysphinx (#245)

* Bump requests from 2.28.2 to 2.31.0 in /docs/.sphinx (#246)

Bumps [requests](https://github.com/psf/requests) from 2.28.2 to 2.31.0.
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](psf/requests@v2.28.2...v2.31.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump rocm-docs-core[api_reference] in /docs/.sphinx (#250)

Bumps [rocm-docs-core[api_reference]](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.11.0 to 0.13.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](ROCm/rocm-docs-core@v0.11.0...v0.13.1)

---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Lőrinc Serfőző <mfep@users.noreply.github.com>
Co-authored-by: Sam Wu <sam.wu2@amd.com>
Co-authored-by: samjwu <samjwu@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
samjwu pushed a commit that referenced this pull request Jun 9, 2023
* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
samjwu pushed a commit that referenced this pull request Jun 14, 2023
Updated docs to use the ROCm standard (#236)

* HTML documentation uses rocm-docs-core template

* Updated changelog.md

* Removed redundant inputs from doxyfile

* Reverted file patterns in Doxyfile

* Updated .gitignore

Add dependabot config and Pin rocm-docs-core (#237)

* Add dependabot config and pin rocm-docs-core

* pin exhale

---------

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

Update documentation requirements - replaces exhale with doxysphinx (#245)

rocm-docs-core[api_reference]==0.13.4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants