cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #12908 from tharun634/move-docs

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.circleci/config.yml
View File

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

2
docs/contributing.rst
View File

@ -475,7 +475,7 @@ For example ``pragma solidity >=0.4.0 <0.9.0;``.
Running Documentation Tests 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. needed for documentation and checks for any problems such as broken links or syntax issues.
Solidity Language Design Solidity Language Design

8
scripts/docs.sh → docs/docs.sh
View File

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