NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove DOMAIN_SEPARATOR from Votes and update docs examples (#4297)

Browse Source 
Co-authored-by: Qiwei Yang <yangqiwei97@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
This commit is contained in:
Francisco
2023-06-02 16:02:57 +01:00
committed by GitHub
parent 5cef83d2c7
commit 3902a410f1
12 changed files with 186 additions and 224 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
scripts/prepare-docs.sh
View File

@ -1,6 +1,7 @@
#!/usr/bin/env bash
set -euo pipefail
shopt -s globstar
OUTDIR="$(node -p 'require("./docs/config.js").outputDir')"
@ -13,11 +14,13 @@ rm -rf "$OUTDIR"
hardhat docgen
# copy examples and adjust imports
examples_dir="docs/modules/api/examples"
mkdir -p "$examples_dir"
for f in contracts/mocks/docs/*.sol; do
name="$(basename "$f")"
sed -e '/^import/s|\.\./\.\./|@openzeppelin/contracts/|' "$f" > "docs/modules/api/examples/$name"
examples_source_dir="contracts/mocks/docs"
examples_target_dir="docs/modules/api/examples"
for f in "$examples_source_dir"/**/*.sol; do
name="${f/#"$examples_source_dir/"/}"
mkdir -p "$examples_target_dir/$(dirname "$name")"
sed -Ee '/^import/s|"(\.\./)+|"@openzeppelin/contracts/|' "$f" > "$examples_target_dir/$name"
done
node scripts/gen-nav.js "$OUTDIR" > "$OUTDIR/../nav.adoc"