9012a748d3
This commit gets the doc directory and Sphinx configuration started. Further documentation will depend on the Sphinx files and the index.rst file at the very least. The dev-requirements were updated to install Sphinx, and a gating script was added to do the building for when we move to actually do gating on the docs. The docs gate script is currently set to treat warning as errors. Change-Id: I977a2e53f1b0981cbc702ac53f2198d9f6a9da9d Implements: blueprint developer-docs
39 lines
1.2 KiB
Bash
Executable File
39 lines
1.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Copyright 2014, Rackspace US, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
## Shell Opts ----------------------------------------------------------------
|
|
set -e -u -x
|
|
|
|
|
|
## Library Check -------------------------------------------------------------
|
|
info_block "Checking for required libraries." 2> /dev/null || source $(dirname ${0})/scripts-library.sh
|
|
|
|
|
|
## Main ----------------------------------------------------------------------
|
|
info_block "Running Basic Ansible Lint Check"
|
|
|
|
|
|
# Install the development requirements.
|
|
if [ -f "dev-requirements.txt" ]; then
|
|
pip2 install -r dev-requirements.txt || pip install -r dev-requirements.txt
|
|
fi
|
|
|
|
pushd doc
|
|
info_block "Building HTML docs"
|
|
|
|
# Treat warnings as errors.
|
|
make html SPHINXOPTS="-W"
|
|
popd
|