Skip to content

sof-docs: build out of source directory #9878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgirdwood merged 2 commits into from
Apr 8, 2025
Merged

sof-docs: build out of source directory #9878

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbb8b7d
scripts: gen-doc: enforce python virtual environment
lgirdwood Mar 1, 2025
3e3ce61
scripts: gen-doc: move all build output of source directory.
lrgirdwo Mar 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions scripts/gen-doc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,25 @@
# According to instructions:
# https://thesofproject.github.io/latest/howtos/process/docbuild.html

# fail immediately on any errors
set -e
# this needs to run from the Zephyr python virtual environment
# so that the python packages are available (and more up to date than
# the system packages).

# check if Zephyr environment is set up
if [ ! -z "$ZEPHYR_BASE" ]; then
VENV_DIR="$ZEPHYR_BASE/.venv"
echo "Using Zephyr environment at $ZEPHYR_BASE"
elif [ ! -z "$SOF_WORKSPACE" ]; then
VENV_DIR="$SOF_WORKSPACE/zephyr/.venv"
echo "Using SOF/Zephyr environment at $SOF_WORKSPACE"
else
# fallback to the zephyr default from the getting started guide
VENV_DIR="$HOME/zephyrproject/.venv"
echo "Using default Zephyr environment at $VENV_DIR"
fi

# start the virtual environment
source ${VENV_DIR}/bin/activate

function print_usage()
{
Expand All @@ -21,11 +38,11 @@ function print_usage()
# make it runnable from any location
# user shouldn't be confused from which dir this script has to be run
SCRIPT_DIR=$(cd "$(dirname "$0")" && pwd)

# expected paths of repositories needed for documentation process
SOF_REPO=$(dirname "$SCRIPT_DIR")
DOCS_REPO="$(dirname "$SOF_REPO")/sof-docs"
PUBLISH_REPO="$(dirname "$SOF_REPO")/thesofproject.github.io"
BUILD_DIR="$(dirname "$SOF_REPO")/build-sof-docs"

# parse arguments
DO_BUILD=false
Expand Down Expand Up @@ -73,20 +90,19 @@ then
fi
fi

cd "$SOF_REPO/doc"

if "$DO_CLEAN"
then
echo "Cleaning $SOF_REPO"
cmake .
cd ${BUILD_DIR}
make clean
make doc-clean
fi

if "$DO_BUILD"
then
echo "Building $SOF_REPO"
cmake .
cd "$SOF_REPO/doc"
cmake -S . -B ${BUILD_DIR}
make doc
fi

Expand Down Expand Up @@ -133,3 +149,6 @@ then
cd "$DOCS_REPO"
make publish
fi

# cleanup
deactivate
Loading