removing deprecated "update-docs.sh" script in favor of automatic documentation

builds (#22)

Signed-off-by: Karl W. Schulz <karl.schulz@amd.com>
Этот коммит содержится в:
Karl W. Schulz
2022-12-21 12:46:18 -06:00
родитель e9ceefb23d
Коммит b5ac023307
2 изменённых файлов: 6 добавлений и 29 удалений
+6
Просмотреть файл
@@ -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.
-29
Просмотреть файл
@@ -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