HOTFIX: Update version number and changelog for ROCm 6.1 (#184)

* Update version number and changelog for ROCm 6.1

* Update documentation to match ROCm (#142)

* Update documentation requirements files

* Disable docsphinx test on macOS (#167)

---------

Co-authored-by: Sam Wu <sam.wu2@amd.com>

Author: lawruble13

.github/dependabot.yml

@@ -0,0 +1,17 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/docs" # Location of package manifests
+    open-pull-requests-limit: 10
+    schedule:
+      interval: "daily"
+    labels:
+      - "documentation"
+      - "dependencies"
+      - "ci:docs-only"
+    reviewers:
+      - "samjwu"

.github/workflows/test.yml

@@ -56,7 +56,7 @@ jobs:
       run: |
         python -m pip install --upgrade setuptools pip wheel
         python -m pip install cget ninja
-        python -m pip install -r doc/requirements.txt
+        python -m pip install -r docs/requirements.txt
         python -m pip install -r test/docsphinx/docs/.sphinx/requirements.txt
     - name: Install Doxygen
       uses: ssciwr/doxygen-install@v1
@@ -69,4 +69,3 @@ jobs:
         cget build -T doc
         cget build -Cy --test -DROCM_CMAKE_GENERATOR=Ninja
         cget build -T doc
-

.gitignore

@@ -1,2 +1,4 @@
 .vs*/**/*
-build/**/*
+build/**/*
+docs/_build/
+docs/sphinx/_toc.yml

.readthedocs.yaml

@@ -0,0 +1,18 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+sphinx:
+  configuration: docs/src/conf.py
+
+formats: [htmlzip, pdf, epub]
+
+python:
+  install:
+  - requirements: docs/requirements.txt
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log for rocm-cmake
 
+## [rocm-cmake 0.12.0 for ROCm 6.1.0]
+### Changed
+- ROCMSphinxDoc: Allow separate source and config directories.
+- ROCMCreatePackage: Allow additional `PROVIDES` on header-only packages.
+- ROCMInstallTargets: Don't install executable targets by default for ASAN builds.
+- ROCMTest: Add RPATH for installed tests.
+- Finalize rename to ROCmCMakeBuildTools
+### Fixed
+- ROCMClangTidy: Fixed invalid list index.
+- Test failures when ROCM_CMAKE_GENERATOR is empty.
+
+
 ## [rocm-cmake 0.11.0 for ROCm 6.0.0]
 ### Changed
 - ROCMSphinxDoc: Improved validation, documentation and rocm-docs-core integration.

CMakeLists.txt

@@ -20,7 +20,7 @@ list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/share/rocmcmakebuildtool
 include(ROCMCreatePackage)
 include(ROCMSetupVersion)
 
-rocm_setup_version(VERSION 0.11.0)
+rocm_setup_version(VERSION 0.12.0)
 
 include(CMakePackageConfigHelpers)
 write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/ROCmCMakeBuildToolsConfigVersion.cmake
@@ -43,4 +43,4 @@ add_custom_target(format COMMAND cmake-format -i ${CMAKE_FILES} WORKING_DIRECTOR
 enable_testing()
 add_custom_target(check COMMAND ${CMAKE_CTEST_COMMAND} --output-on-failure -C ${CMAKE_CFG_INTDIR})
 add_subdirectory(test)
-add_subdirectory(doc)
+add_subdirectory(docs)

README.md

@@ -1,5 +1,4 @@
-rocm-cmake
-==================
+# rocm-cmake
 
 rocm-cmake is a collection of CMake modules for common build and development
 tasks within the ROCm project. It is therefore a build dependency for many of
@@ -10,8 +9,10 @@ it is required for building some of the libraries that are _a part of_ ROCm.
 
 To install from source, run:
 
-    mkdir build
-    cd build
-    cmake ..
-    cmake --build .
-    sudo cmake --build . --target install
+```bash
+mkdir build
+cd build
+cmake ..
+cmake --build .
+sudo cmake --build . --target install
+```

doc/CMakeLists.txt

@@ -0,0 +1,5 @@
+include(ROCMSphinxDoc)
+rocm_add_sphinx_doc(${CMAKE_CURRENT_LIST_DIR}/src
+    BUILDER html
+    OUTPUT_DIR html
+)

docs/CMakeLists.txt

@@ -1,2 +1,2 @@
-sphinx==4.1.2
-sphinxcontrib-moderncmakedomain==3.19
+sphinxcontrib-moderncmakedomain==3.19
+rocm-docs-core==0.38.1