Kandula, Venkateshwar reddy
6ec9526475
* Use custom .rst to make api doc more readable. * Update index.rst * Misc docs updates - doxygen source code fixes - updated doxygen files - fixed conf.py (does not generate code in source tree) * Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api/modules.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api/global_data_structures_topics_files.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Duplicate * test warnings * Update CMakeLists.txt * Update rocprofiler-sdk.dox.in * Update update-docs.sh * fix docs build failures by -q -T flags. * set warn_as_error to NO. * test -W to suppress warnings. * remove -q flag from make. * reduce dot graph depth to 100 * Update custom docs target - docs target is now no longer part of the dependency list for the all target - installation of docs requires explicitly building the docs target (i.e. OPTIONAL install of _build/html/ folder) * add quit and trace mode back. * increase DOT_GRAPH_MAX_NODES to 500 back. * Format. --------- Co-authored-by: Venkateshwar Reddy Kandula <vkandula@amd.com> Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com> Co-authored-by: Bhardwaj, Gopesh <Gopesh.Bhardwaj@amd.com> Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com>
48 lignes
1.4 KiB
Bash
Fichiers exécutables
48 lignes
1.4 KiB
Bash
Fichiers exécutables
#!/bin/bash -e
|
|
|
|
message()
|
|
{
|
|
echo -e "\n\n##### ${@}... #####\n"
|
|
}
|
|
|
|
WORK_DIR=$(cd $(dirname ${BASH_SOURCE[0]})/../docs &> /dev/null && 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 ${SOURCE_DIR}"
|
|
cd ${SOURCE_DIR}
|
|
|
|
message "Configurating cmake..."
|
|
cmake -B build-docs ${SOURCE_DIR} -DROCPROFILER_INTERNAL_BUILD_DOCS=ON
|
|
|
|
message "Changing directory to ${WORK_DIR}"
|
|
cd ${WORK_DIR}
|
|
|
|
message "Generating rocprofiler-sdk.dox"
|
|
cmake -DSOURCE_DIR=${SOURCE_DIR} -DPROJECT_NAME="ROCprofiler-SDK" -P ${WORK_DIR}/generate-doxyfile.cmake
|
|
|
|
message "Generating doxygen xml files"
|
|
mkdir -p _doxygen
|
|
doxygen rocprofiler-sdk.dox
|
|
doxygen rocprofiler-sdk-roctx.dox
|
|
|
|
message "Running doxysphinx"
|
|
doxysphinx build ${WORK_DIR} ${WORK_DIR}/_build/html ${WORK_DIR}/_doxygen/rocprofiler-sdk/html
|
|
doxysphinx build ${WORK_DIR} ${WORK_DIR}/_build/html ${WORK_DIR}/_doxygen/roctx/html
|
|
|
|
message "Building html documentation"
|
|
make html SPHINXOPTS="--keep-going -n -q -T"
|
|
|
|
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
|