Skip to content
Snippets Groups Projects
Unverified Commit 080e59ed authored by drebs's avatar drebs
Browse files

[doc] add script to build docs

parent 5a6d04ca
No related branches found
No related tags found
No related merge requests found
......@@ -3,3 +3,9 @@ default:
upload_packages:
python setup.py sdist bdist_wheel --universal upload --sign -i $(MAINTAINER) -r pypi
docs:
(cd docs && make html)
docs-using-virtualenv:
./scripts/docs/build-soledad-doc.sh
#!/bin/sh
# This script builds the Soledad documentation using a virtual environment.
# You can pass the target directory as the first command line argument:
#
# ./build-soledad-doc.sh [target-dir]
#
# If you no directory is passed, documentation will be built on the default
# place used by sphinx: <repodir>/docs/_build
set -eu
set -o xtrace
BUILDDIR=${1:-_build}
REPO="http://0xacab.org/leap/soledad"
REPO=/tmp/soledad
TEMPDIR=$(mktemp -d)
VENVDIR=${TEMPDIR}/venv
REPODIR=${TEMPDIR}/soledad
TARGET=html
if [[ ${BUILDDIR} = /* ]]; then
type="absolute"
docdir=${BUILDDIR}/${TARGET}
else
type="relative"
docdir=${REPODIR}/docs/${BUILDDIR}/${TARGET}
fi
echo "Documentation will be written to ${type} path ${BUILDDIR}."
# build and activate the virtual environment
if [ ! -d ${VENVDIR} ]; then
virtualenv ${VENVDIR}
fi
. ${VENVDIR}/bin/activate
# clone the canonical repository
git clone ${REPO} ${REPODIR}
# install deps
pip install -U pip wheel
pip install -r ${REPODIR}/docs/requirements.pip
# build documentation
make -C ${REPODIR}/docs ${TARGET} BUILDDIR=${BUILDDIR}
ls -1 ${docdir}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment