mirror of
https://github.com/ceph/ceph
synced 2024-12-22 19:34:30 +00:00
c65ffe9f7f
This avoids the delay of installing Sphinx inside the virtualenv; especially, compiling lxml is slow. If Sphinx is not installed system-wide (or it's too old), this will still install a copy inside the virtualenv, to keep working. Thanks to Sean for the push to make this happen, and testing the various scenarios; I (Tv) took the liberty of changing the commit to use venv-python for the manpage build too, avoid the nonstandard "which" command, be more careful about quoting, and explain more fully what's going on in the comment. Closes: https://github.com/ceph/ceph/pull/24 Signed-off-by: Sean Channel <pentabular@gmail.com> Signed-off-by: Tommi Virtanen <tv@inktank.com>
64 lines
1.9 KiB
Bash
Executable File
64 lines
1.9 KiB
Bash
Executable File
#!/bin/sh
|
|
set -e
|
|
cd "$(dirname "$0")"
|
|
cd ..
|
|
|
|
install -d -m0755 build-doc
|
|
|
|
if command -v dpkg >/dev/null; then
|
|
for package in python-dev python-pip python-virtualenv doxygen ditaa; do
|
|
if [ "$(dpkg --status -- $package|sed -n 's/^Status: //p')" != "install ok installed" ]; then
|
|
# add a space after old values
|
|
missing="${missing:+$missing }$package"
|
|
fi
|
|
done
|
|
if [ -n "$missing" ]; then
|
|
echo "$0: missing required packages, please install them:" 1>&2
|
|
echo "sudo apt-get install $missing"
|
|
exit 1
|
|
fi
|
|
else
|
|
for command in virtualenv doxygen ditaa; do
|
|
if ! command -v "$command" >/dev/null; then
|
|
# add a space after old values
|
|
missing="${missing:+$missing }$package"
|
|
fi
|
|
done
|
|
if [ -n "$missing" ]; then
|
|
echo "$0: missing required command, please install them:" 1>&2
|
|
echo "$missing"
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
if [ ! -e build-doc/doxygen/xml ]; then
|
|
doxygen
|
|
fi
|
|
|
|
cat src/osd/PG.h src/osd/PG.cc | doc/scripts/gen_state_diagram.py > doc/dev/peering_graph.generated.dot
|
|
|
|
cd build-doc
|
|
|
|
[ -z "$vdir" ] && vdir="./virtualenv"
|
|
|
|
if [ ! -e $vdir ]; then
|
|
virtualenv --system-site-packages $vdir
|
|
fi
|
|
$vdir/bin/pip install -r ../admin/doc-requirements.txt
|
|
|
|
sphinx_build="$vdir/bin/sphinx-build"
|
|
if [ ! -e $sphinx_build ]; then
|
|
# If sphinx is not installed inside the virtualenv (that is, we
|
|
# have a system-wide sphinx installed and it is new enough), use
|
|
# that. As we need to use the python interpreter from inside the
|
|
# virtualenv to make the sphinx extensions visible, we need need
|
|
# to know the full path to the sphinx-build script.
|
|
sphinx_build="$(command -v -p sphinx-build)"
|
|
fi
|
|
|
|
install -d -m0755 \
|
|
output/html \
|
|
output/man
|
|
PYTHONPATH="$(pwd)/../src/pybind" "$vdir/bin/python" "$sphinx_build" -a -b dirhtml -d doctrees ../doc output/html
|
|
"$vdir/bin/python" "$sphinx_build" -a -b man -d doctrees ../doc output/man
|