Merge pull request #12908 from tharun634/move-docs

Moved `docs.sh` script to `docs/`
This commit is contained in:
Kamil Śliwak 2022-04-11 13:51:05 +02:00 committed by GitHub
commit e684b36b25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 5 deletions

View File

@ -987,7 +987,7 @@ jobs:
- run: *setup_prerelease_commit_hash
- run:
name: Build documentation
command: ./scripts/docs.sh
command: ./docs/docs.sh
- store_artifacts:
path: docs/_build/html/
destination: docs-html

View File

@ -475,7 +475,7 @@ For example ``pragma solidity >=0.4.0 <0.9.0;``.
Running Documentation Tests
---------------------------
Make sure your contributions pass our documentation tests by running ``./scripts/docs.sh`` that installs dependencies
Make sure your contributions pass our documentation tests by running ``./docs/docs.sh`` that installs dependencies
needed for documentation and checks for any problems such as broken links or syntax issues.
Solidity Language Design

View File

@ -26,8 +26,10 @@
# (c) 2016 solidity contributors.
#------------------------------------------------------------------------------
set -e
cd docs
set -euo pipefail
script_dir="$(dirname "$0")"
cd "${script_dir}"
pip3 install -r requirements.txt --upgrade --upgrade-strategy eager
sphinx-build -nW -b html -d _build/doctrees . _build/html
cd ..