diff --git a/projects/rocprofiler-compute/src/docs/README b/projects/rocprofiler-compute/src/docs/README new file mode 100644 index 0000000000..d888e91be2 --- /dev/null +++ b/projects/rocprofiler-compute/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. diff --git a/projects/rocprofiler-compute/src/docs/update-docs.sh b/projects/rocprofiler-compute/src/docs/update-docs.sh deleted file mode 100755 index f607a3c20e..0000000000 --- a/projects/rocprofiler-compute/src/docs/update-docs.sh +++ /dev/null @@ -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 \ No newline at end of file