Merge pull request #60 from AMDResearch/main

Pull changes from main into dev

CHANGES

@@ -1,3 +1,8 @@
+Version 1.0.6 (21 Dec 2022)
+
+  * CI update: documentation now published via github action (#22)
+  * better error detection for incomplete ROCm installs (#56)
+
 Version 1.0.5 (13 Dec 2022)
 
   * store application command-line parameters in profiling output (#27)

README.md

@@ -1,6 +1,6 @@
-[![Docs](https://github.com/AMDResearch/omniperf/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://amdresearch.github.io/omniperf/)
+[![Docs](https://github.com/AMDResearch/omniperf/actions/workflows/docs.yml/badge.svg)](https://amdresearch.github.io/omniperf/)
 [![DOI](https://zenodo.org/badge/561919887.svg)](https://zenodo.org/badge/latestdoi/561919887)
-[![GitHub commits since last release](https://img.shields.io/github/commits-since/AMDResearch/omniperf/latest/dev.svg)](https://github.com/AMDResearch/omniperf/compare/main...dev) 
+
 
 # Omniperf
 
@@ -41,17 +41,17 @@ This software can be cited using a Zenodo
 style reference is provided below for convenience:
 
 ```
-@software{xiamin_lu_2022_7434848,
+@software{xiamin_lu_2022_7314631
   author       = {Xiaomin Lu and
                   Cole Ramos and
                   Fei Zheng and
                   Karl W. Schulz and
                   Jose Santos},
-  title        = {AMDResearch/omniperf: v1.0.5 (13 December 2022)},
+  title        = {AMDResearch/omniperf: v1.0.6 (21 December 2022)},
   month        = dec,
   year         = 2022,
   publisher    = {Zenodo},
-  version      = {v1.0.5},
+  version      = {v1.0.6},
   doi          = {10.5281/zenodo.7314631},
   url          = {https://doi.org/10.5281/zenodo.7314631}
 }

src/docs/README

@@ -0,0 +1,6 @@
+This subdirectory houses the input markup for Omniperf documentation using
+Sphinx. Changes committed here on the main branch will automatically be built
+and pushed live using a Github action.
+
+You can build a local copy of the documentation in this directory using
+"make html" assuming you have the necessary sphinx dependencies installed.

src/docs/update-docs.sh

@@ -1,29 +0,0 @@
-#!/bin/bash -e
-
-message()
-{
-    echo -e "\n\n##### ${@}... #####\n"
-}
-
-WORK_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) && pwd)
-SOURCE_DIR=$(cd ${WORK_DIR}/../.. &> /dev/null && pwd)
-
-message "Working directory is ${WORK_DIR}"
-message "Source directory is ${SOURCE_DIR}"
-
-message "Changing directory to ${WORK_DIR}"
-cd ${WORK_DIR}
-
-message "Building html documentation"
-make html
-
-if [ -d ${SOURCE_DIR}/docs ]; then
-    message "Removing stale documentation in ${SOURCE_DIR}/docs/"
-    rm -rf ${SOURCE_DIR}/docs/*
-
-    message "Adding nojekyll to docs/"
-    cp -r ${WORK_DIR}/.nojekyll ${SOURCE_DIR}/docs/.nojekyll
-
-    message "Copying source/docs/_build/html/* to docs/"
-    cp -r ${WORK_DIR}/_build/html/* ${SOURCE_DIR}/docs/
-fi