summaryrefslogtreecommitdiff
path: root/share/spack/qa/run-doc-tests
blob: eeba12d8d68eee986cad351687dd6b098ab8d6a2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#!/bin/bash -e
#
# Copyright 2013-2020 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

#
# Description:
#     Builds Spack documentation and checks for
#     possible syntax errors. Treats warnings as
#     fatal errors.
#
# Usage:
#     run-doc-tests
#
. "$(dirname $0)/setup.sh"
check_dependencies sphinx-apidoc sphinx-build dot git hg svn

# Move to documentation directory
# Allows script to be run from anywhere
cd "$SPACK_ROOT/lib/spack/docs"

# Treat warnings as fatal errors
make clean --silent
make SPHINXOPTS=-W