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.

Sign up for GitHub

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

Jump to bottom

Documentation Standardization #330

Closed
42 of 44 tasks
samjwu opened this issue Aug 4, 2023 · 3 comments
Closed
42 of 44 tasks

Documentation Standardization #330

samjwu opened this issue Aug 4, 2023 · 3 comments
Assignees
@samjwu
Labels
documentation Improvements or additions to documentation

Comments

@samjwu
Copy link
Member

samjwu commented Aug 4, 2023 •
edited
Loading

Apply the following changes to project documentation for ReadtheDocs:

  • add version number to documentation left navigation bar and page title
  • add an "About" section with a license page
  • enable htmlzip, pdf, epub formats when publishing on Read the Docs
  • set pdf title, author, copyright, and version
  • rename .sphinx/.doxygen to sphinx/doxygen
  • remove docBin from URL
  • update rocm-docs-core dependency
  • update dependabot config

List

  • GPUOpen-ProfessionalCompute-Libraries MIVisionX
  • GPUOpen-ProfessionalCompute-Libraries rpp
  • ROCm-Developer-Tools HIP
  • ROCm-Developer-Tools HIP-VS
  • ROCm-Developer-Tools HIPCC
  • ROCm-Developer-Tools HIPIFY
  • ROCm-Developer-Tools ROCdbgapi-docs
  • ROCm-Developer-Tools ROCgdb-docs
  • ROCm-Developer-Tools ROCmValidationSuite
  • ROCm-Developer-Tools rocprofiler-docs
  • ROCm-Developer-Tools roctracer-docs
  • ROCmSoftwarePlatform AMDMIGraphX
  • ROCmSoftwarePlatform MIOpen
  • ROCmSoftwarePlatform TransferBench
  • ROCmSoftwarePlatform composable_kernel
  • ROCmSoftwarePlatform hip-python main
  • ROCmSoftwarePlatform hipBLAS
  • ROCmSoftwarePlatform hipBLASLt
  • ROCmSoftwarePlatform hipCUB
  • ROCmSoftwarePlatform hipFFT
  • ROCmSoftwarePlatform hipRAND
  • ROCmSoftwarePlatform hipSOLVER
  • ROCmSoftwarePlatform hipSPARSE
  • ROCmSoftwarePlatform hipSPARSELt
  • ROCmSoftwarePlatform hipTensor
  • ROCmSoftwarePlatform hipfort
  • ROCmSoftwarePlatform rccl
  • ROCmSoftwarePlatform rocAL
  • ROCmSoftwarePlatform rocALUTION
  • ROCmSoftwarePlatform rocBLAS
  • ROCmSoftwarePlatform rocFFT
  • ROCmSoftwarePlatform rocPRIM
  • ROCmSoftwarePlatform rocRAND
  • ROCmSoftwarePlatform rocSOLVER
  • ROCmSoftwarePlatform rocSPARSE
  • ROCmSoftwarePlatform rocThrust
  • ROCmSoftwarePlatform rocWMMA
  • RadeonOpenCompute ROCR-Runtime
  • RadeonOpenCompute ROCm
  • RadeonOpenCompute amdsmi
  • RadeonOpenCompute rdc
  • RadeonOpenCompute rocm-cmake
  • RadeonOpenCompute rocm-docs-core
  • RadeonOpenCompute rocm_smi_lib
@samjwu samjwu added the documentation Improvements or additions to documentation label Aug 4, 2023
@samjwu samjwu self-assigned this Aug 4, 2023
This was referenced Aug 4, 2023
Closed
Merged
kiritigowda pushed a commit to ROCm/rocAL that referenced this issue Aug 9, 2023
@samjwu
Documentation - Doxygen documentation for on Read the Docs output and…
4391aa3 
… other documentation standardization (#49)

* update bot config and set linting workflow

* update rtd config

* standardization changes for docs

reference ROCm/rocm-docs-core#330

* integrate doxygen with docs site

also fix some documentation

* include doxysphinx in requirements

for doxygen integration
@samjwu
Copy link
Member Author

samjwu commented Aug 16, 2023

ROCm/rocSPARSE#347

ROCm/rocSPARSE#347 (comment)

https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-fail-on-warning

Sphinx fail as warning

@samjwu
Copy link
Member Author

samjwu commented Aug 23, 2023 •
edited
Loading

Very important:

replace build.image with build.os in the .readthedocs.yaml config

https://docs.readthedocs.io/en/stable/config-file/v2.html

build.image will be deprecated in October 2023

@samjwu samjwu mentioned this issue Aug 23, 2023
Merged
samjwu added a commit to samjwu/TransferBench that referenced this issue Oct 19, 2023
@samjwu
Standardize documentation
b244bdf 
Applies changes noted in ROCm/rocm-docs-core#330
This was referenced Oct 19, 2023
Merged
Merged
samjwu added a commit to samjwu/hipSOLVER that referenced this issue Oct 25, 2023
@samjwu
Standardize documentation
13a2bdd 
Relates to ROCm/rocm-docs-core#330
@samjwu samjwu mentioned this issue Oct 25, 2023
Merged
samjwu added a commit to samjwu/rocSOLVER that referenced this issue Oct 25, 2023
@samjwu
Documentation standardization
11612c3 
Relates to ROCm/rocm-docs-core#330
@samjwu samjwu mentioned this issue Oct 25, 2023
Merged
samjwu added a commit to samjwu/rpp that referenced this issue Oct 27, 2023
@samjwu
Standardize Sphinx documentation and add doxygen integration via doxy…
c10970c 
…sphinx

Relates to ROCm/rocm-docs-core#330
@samjwu samjwu mentioned this issue Oct 27, 2023
Merged
kiritigowda pushed a commit to ROCm/rpp that referenced this issue Oct 29, 2023
@samjwu
Documentation - Standardize Sphinx documentation and add doxygen inte…
992c552 
…gration via doxysphinx (#243)

* Standardize Sphinx documentation and add doxygen integration via doxysphinx

Relates to ROCm/rocm-docs-core#330

* Include api_reference in requirements.in for doxysphinx
kiritigowda pushed a commit to ROCm/rpp that referenced this issue Oct 31, 2023
@samjwu @kiritigowda
Documentation - Standardize Sphinx documentation and add doxygen inte…
61a2b2e 
…gration via doxysphinx (#243)

* Standardize Sphinx documentation and add doxygen integration via doxysphinx

Relates to ROCm/rocm-docs-core#330

* Include api_reference in requirements.in for doxysphinx
samjwu added a commit to ROCm/hipSOLVER that referenced this issue Oct 31, 2023
@samjwu
Standardize documentation (#201)
ef39d5d 
* Standardize documentation

Relates to ROCm/rocm-docs-core#330

* Fix settings for doxygen integration and nav version

Also ignore doc artifacts

* Remove unnecessary and redundant documentation configurations
samjwu added a commit to samjwu/rocSOLVER that referenced this issue Oct 31, 2023
@samjwu
Documentation standardization
599905f 
Relates to ROCm/rocm-docs-core#330
samjwu added a commit to ROCm/rocSOLVER that referenced this issue Oct 31, 2023
@samjwu
Documentation standardization (#626)
f3dbf9c 
Relates to ROCm/rocm-docs-core#330
saadrahim pushed a commit to ROCm/TransferBench that referenced this issue Nov 2, 2023
@samjwu
Standardize documentation (#59)
9dc0a80 
* Standardize documentation

Applies changes noted in ROCm/rocm-docs-core#330

* Fix typo in conf.py

* Import re for conf.py

* Search EnvVars.hpp for version number instead of CMakeLists.txt

* Update Doxyfile output dir

* Change line endings to LF
rocm-ci pushed a commit to ROCm/HIP that referenced this issue Nov 8, 2023
@samjwu
SWDEV-428554 - Standardize HIP Documentation
29a532b 
Relates to ROCm/rocm-docs-core#330

Change-Id: I87468935a1aefa60158b8c07e3911845b3e8da36
searlmc1 pushed a commit to ROCm/llvm-project that referenced this issue Nov 8, 2023
@samjwu
Apply and standardize Read the Docs documentation for HIPCC
65d0571 
Relates to #12

Relates to ROCm/rocm-docs-core#330

Change-Id: Ic6a67f6edb21898c2ac8cf1dce91e94c507af4ad
This was referenced Nov 22, 2023
Merged
Closed
Closed
emankov pushed a commit to emankov/HIPIFY that referenced this issue Nov 23, 2023
@samjwu
Standardize documentation
e453c00 
Relates to ROCm/rocm-docs-core#330
@samjwu samjwu mentioned this issue Nov 23, 2023
Merged
samjwu added a commit to samjwu/composable_kernel that referenced this issue Nov 29, 2023
@samjwu
Standardize documentation for ReadtheDocs
2ace821 
Relates to ROCm/rocm-docs-core#330
@samjwu samjwu mentioned this issue Dec 1, 2023
Merged
samjwu added a commit to ROCm/composable_kernel that referenced this issue Dec 5, 2023
@samjwu
Standardize documentation for ReadtheDocs (#1057)
f60cd9d 
Relates to ROCm/rocm-docs-core#330
asroy pushed a commit to asroy/ck_tile that referenced this issue Dec 9, 2023
@samjwu @asroy
Standardize documentation for ReadtheDocs (#1057)
ffd418f 
Relates to ROCm/rocm-docs-core#330
rocm-ci pushed a commit to ROCm/rdc that referenced this issue Dec 13, 2023
@samjwu
Standardize documentation for ReadtheDocs
5890852 
Relates to ROCm/rocm-docs-core#330

Change-Id: Ic9370548bb8d919376b20f7e1800fe620369e69b
samjwu added a commit to ROCm/HIPIFY that referenced this issue Dec 18, 2023
@samjwu
Standardize documentation
74d1603 
Relates to ROCm/rocm-docs-core#330
This was referenced Dec 21, 2023
Merged
Merged
This was referenced Dec 29, 2023
Merged
Merged
Merged
Merged
Merged
Merged
This was referenced Jan 6, 2024
Merged
Merged
Merged
samjwu added a commit to samjwu/rocm-docs-core that referenced this issue Jan 12, 2024
@samjwu
build: Standardize documentation
f602e1b 
relates to ROCm#330
This was referenced Jan 12, 2024
Merged
Merged
samjwu added a commit to ROCm/ROCmValidationSuite that referenced this issue Jan 15, 2024
@samjwu
Standardize documentation for ReadtheDocs (#677)
765effe 
Relates to ROCm/rocm-docs-core#330
@samjwu
Copy link
Member Author

samjwu commented Jan 15, 2024

ROCR runtime and rocm cmake build tools TBD separately

@samjwu samjwu closed this as completed Jan 15, 2024
This was referenced Jan 17, 2024
Merged
Merged
samjwu added a commit to ROCm/hipFFT that referenced this issue Apr 15, 2024
@samjwu
Standardize documentation
605a60b 
Relates to ROCm/rocm-docs-core#330

Fix line endings; use LF instead of CRLF
samjwu added a commit to ROCm/rocSOLVER that referenced this issue Apr 15, 2024
@samjwu
Documentation standardization (#626)
a545d3d 
Relates to ROCm/rocm-docs-core#330
samjwu added a commit to ROCm/MIOpen that referenced this issue Apr 15, 2024
@samjwu
[Doc] Standardize documentation for ReadtheDocs (#2548)
8b77d2b 
Relates to ROCm/rocm-docs-core#330
yhuiYH pushed a commit to ROCm/llvm-project that referenced this issue May 23, 2024
@samjwu @yhuiYH
Apply and standardize Read the Docs documentation for HIPCC
19578db 
Relates to #12

Relates to ROCm/rocm-docs-core#330

Change-Id: Ic6a67f6edb21898c2ac8cf1dce91e94c507af4ad
yhuiYH added a commit to ROCm/llvm-project that referenced this issue May 23, 2024
@yhuiYH @samjwu @randyh62
Port HIPCC doc reorg to 6.1.1 (#94)
6b51e01 
* Apply and standardize Read the Docs documentation for HIPCC

Relates to #12

Relates to ROCm/rocm-docs-core#330

Change-Id: Ic6a67f6edb21898c2ac8cf1dce91e94c507af4ad

* SWDEV-385160 - clean up references to Environment Variables

Change-Id: I2d1581cda76aa48a46e1f0a173a963c16fe9a36b

* hipcc docs update

* minor edit

* remove note about llvm

* fix syntax

---------

Co-authored-by: Sam Wu <sam.wu2@amd.com>
Co-authored-by: David Salinas <david.salinas@amd.com>
Co-authored-by: randyh62 <randyh@amd.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@samjwu samjwu

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@samjwu