diff options
Diffstat (limited to 'scripts/docs.sh')
| -rw-r--r-- | scripts/docs.sh | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/scripts/docs.sh b/scripts/docs.sh new file mode 100644 index 00000000..a674373a --- /dev/null +++ b/scripts/docs.sh @@ -0,0 +1,33 @@ +#!/usr/bin/env bash + +#------------------------------------------------------------------------------ +# Bash script to build the Solidity Sphinx documentation locally. +# +# The documentation for solidity is hosted at: +# +# https://solidity.readthedocs.org +# +# ------------------------------------------------------------------------------ +# This file is part of solidity. +# +# solidity is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# solidity is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with solidity. If not, see <http://www.gnu.org/licenses/> +# +# (c) 2016 solidity contributors. +#------------------------------------------------------------------------------ + +if [[ "$OSTYPE" == "darwin"* ]]; then + # We aren't building docs locally for macOS at the moment +else + cd docs && sphinx-build -nW -b html -d _build/doctrees . _build/html && cd .. +fi |