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

Standardize hipBLAS documentation builds to use the rocm-docs-core template #566

Merged
merged 25 commits into from
Mar 10, 2023

Conversation

samjwu
Copy link
Member

@samjwu samjwu commented Mar 9, 2023

Summary of proposed changes:

  • Updates the readthedocs documentation to use the rocm-docs-core template

Rationale:

pdf etc not used
@samjwu samjwu self-assigned this Mar 9, 2023
@samjwu samjwu requested a review from saadrahim March 9, 2023 23:56
Copy link
Member

@saadrahim saadrahim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Failures in CI appear unrelated to documentation.

Copy link
Contributor

@daineAMD daineAMD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI failures are due to recent rocBLAS/rocSOLVER interface updates, will get resolved with time. This PR only makes doc changes so okay to be ignored.

Fine by me if fine by Saad, but should wait for @rkamd to review too.

Copy link
Contributor

@rkamd rkamd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@samjwu samjwu changed the title Update documentation to use the rocm-docs-core template Standardize hipBLAS documentation builds to use the rocm-docs-core template Mar 10, 2023
@samjwu samjwu merged commit 36ea680 into develop Mar 10, 2023
@samjwu samjwu deleted the rtd branch March 13, 2023 22:10
daineAMD pushed a commit to daineAMD/hipBLAS that referenced this pull request May 29, 2023
…mplate (ROCm#566)

* Changing Documentation Template

* Changing Documentation Template

* hipBLAS documentation refactored for pitchfork

* Remove old rocm logo

* Reorganize sections to match swab-documentation for reference libraries

https://github.com/RadeonOpenCompute/swab-documentation/blob/main/docs/sphinx/templates/references/reference_library.md

* Moving files around

* Renaming conf.py to sphix_conf.py

* Recompile requirements.txt

* Fix typo

* Renaming back

* Update requirements

* Point requirements to rocm-docs-core

* updating yml

* final move for conf.py

* Update toc file entries

* Renaming folders

* Updating rtd yaml with new folder structure

* Rename sphinx and doxygen folders

prepend . to indicate config folders

* Remove extra header

* Build html only

pdf etc not used

* Add section on how to build documentation locally

---------

Co-authored-by: Sergey Kostrov <[email protected]>
Co-authored-by: Saad Rahim <[email protected]>
daineAMD pushed a commit to daineAMD/hipBLAS that referenced this pull request May 29, 2023
…mplate (ROCm#566)

* Changing Documentation Template

* Changing Documentation Template

* hipBLAS documentation refactored for pitchfork

* Remove old rocm logo

* Reorganize sections to match swab-documentation for reference libraries

https://github.com/RadeonOpenCompute/swab-documentation/blob/main/docs/sphinx/templates/references/reference_library.md

* Moving files around

* Renaming conf.py to sphix_conf.py

* Recompile requirements.txt

* Fix typo

* Renaming back

* Update requirements

* Point requirements to rocm-docs-core

* updating yml

* final move for conf.py

* Update toc file entries

* Renaming folders

* Updating rtd yaml with new folder structure

* Rename sphinx and doxygen folders

prepend . to indicate config folders

* Remove extra header

* Build html only

pdf etc not used

* Add section on how to build documentation locally

---------

Co-authored-by: Sergey Kostrov <[email protected]>
Co-authored-by: Saad Rahim <[email protected]>
samjwu added a commit that referenced this pull request Jun 9, 2023
…mplate (#566)

* Changing Documentation Template

* Changing Documentation Template

* hipBLAS documentation refactored for pitchfork

* Remove old rocm logo

* Reorganize sections to match swab-documentation for reference libraries

https://github.com/RadeonOpenCompute/swab-documentation/blob/main/docs/sphinx/templates/references/reference_library.md

* Moving files around

* Renaming conf.py to sphix_conf.py

* Recompile requirements.txt

* Fix typo

* Renaming back

* Update requirements

* Point requirements to rocm-docs-core

* updating yml

* final move for conf.py

* Update toc file entries

* Renaming folders

* Updating rtd yaml with new folder structure

* Rename sphinx and doxygen folders

prepend . to indicate config folders

* Remove extra header

* Build html only

pdf etc not used

* Add section on how to build documentation locally

---------

Co-authored-by: Sergey Kostrov <[email protected]>
Co-authored-by: Saad Rahim <[email protected]>
samjwu added a commit that referenced this pull request Jun 14, 2023
Standardize hipBLAS documentation builds to use the rocm-docs-core template  (#566)

* Changing Documentation Template

* Changing Documentation Template

* hipBLAS documentation refactored for pitchfork

* Remove old rocm logo

* Reorganize sections to match swab-documentation for reference libraries

https://github.com/RadeonOpenCompute/swab-documentation/blob/main/docs/sphinx/templates/references/reference_library.md

* Moving files around

* Renaming conf.py to sphix_conf.py

* Recompile requirements.txt

* Fix typo

* Renaming back

* Update requirements

* Point requirements to rocm-docs-core

* updating yml

* final move for conf.py

* Update toc file entries

* Renaming folders

* Updating rtd yaml with new folder structure

* Rename sphinx and doxygen folders

prepend . to indicate config folders

* Remove extra header

* Build html only

pdf etc not used

* Add section on how to build documentation locally

---------

Co-authored-by: Sergey Kostrov <[email protected]>
Co-authored-by: Saad Rahim <[email protected]>

Update requirements.txt (#574)

* update requirements

remove unused .gitignore

* fix typo in functions docs page

* brain float 16

* remove disclaimer

Add dependabot config and pin rocm-docs-core (#586)

Update dependabot config (#589)

Co-authored-by: samjwu <[email protected]>

rocm-docs-core==0.13.4

remove old docs action (#598)
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.

5 participants