spack/share/spack/qa/run-doc-tests

#!/bin/bash -e
#
# 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
Separate integration tests; simplify test scripts (#4006) * Separate build integration tests; simplify test scripts - Move build tests out of the regular Travis unit tests, add more smoke test packages to build. - Run all test scripts with bash -e, which fails on error. - Factor coverage out into a Travis environment variable, so it's more obvious from .travis.yml which tests contribute to coverage and which don't. - Factor dependency checking and much of the front-matter in tests scripts into a setup.sh script, which is sourced by all the test scripts. Extra cruft in each tests script now reduced to 2 lines at the beginning. 2017-04-28 02:47:56 +08:00			`#!/bin/bash -e`
Run documentation tests when documentation is modified 2016-08-23 05:57:53 +08:00			`#`
			`# Description:`
			`# Builds Spack documentation and checks for`
			`# possible syntax errors. Treats warnings as`
			`# fatal errors.`
			`#`
			`# Usage:`
			`# run-doc-tests`
			`#`
Separate integration tests; simplify test scripts (#4006) * Separate build integration tests; simplify test scripts - Move build tests out of the regular Travis unit tests, add more smoke test packages to build. - Run all test scripts with bash -e, which fails on error. - Factor coverage out into a Travis environment variable, so it's more obvious from .travis.yml which tests contribute to coverage and which don't. - Factor dependency checking and much of the front-matter in tests scripts into a setup.sh script, which is sourced by all the test scripts. Extra cruft in each tests script now reduced to 2 lines at the beginning. 2017-04-28 02:47:56 +08:00			`. "$(dirname $0)/setup.sh"`
			`check_dependencies sphinx-apidoc sphinx-build dot git hg svn`
Add spack to the PATH for doc tests 2016-08-30 00:10:06 +08:00
Only run unit tests when core Spack framework is modified 2016-08-23 07:40:53 +08:00			`# Move to documentation directory`
			`# Allows script to be run from anywhere`
Separate integration tests; simplify test scripts (#4006) * Separate build integration tests; simplify test scripts - Move build tests out of the regular Travis unit tests, add more smoke test packages to build. - Run all test scripts with bash -e, which fails on error. - Factor coverage out into a Travis environment variable, so it's more obvious from .travis.yml which tests contribute to coverage and which don't. - Factor dependency checking and much of the front-matter in tests scripts into a setup.sh script, which is sourced by all the test scripts. Extra cruft in each tests script now reduced to 2 lines at the beginning. 2017-04-28 02:47:56 +08:00			`cd "$SPACK_ROOT/lib/spack/docs"`
Only run unit tests when core Spack framework is modified 2016-08-23 07:40:53 +08:00
Always run Documentation tests 2016-08-25 05:56:59 +08:00			`# Treat warnings as fatal errors`
Run make clean to prevent warning messages (#1742) * Run make clean to prevent warning messages * Don't delete temporary files after completion 2016-10-03 09:51:09 +08:00			`make clean --silent`
Sphinx no longer supports Python 2.6 (#4266) * Sphinx no longer supports Python 2.6 * Update vendored sphinxcontrib.programoutput from 0.9.0 to 0.10.0 * Documentation cannot be built in parallel * Let Travis install programoutput for us * Remove vendored sphinxcontrib-programoutput Recent updates to the sphinx package prevent the vendored version from being found in sys.path. We don't vendor sphinx, so it doesn't make sense to vendor sphinxcontrib-programoutput either. 2017-05-18 00:36:02 +08:00			`make SPHINXOPTS=-W`