Update docs

docs-v4.x
github-actions 2 years ago
parent 18fd78ad7f
commit 1c27127341
  1. 10
      docs/modules/api/examples/governance/MyGovernor.sol
  2. 6
      docs/modules/api/examples/governance/MyToken.sol
  3. 6
      docs/modules/api/examples/governance/MyTokenTimestampBased.sol
  4. 8
      docs/modules/api/examples/governance/MyTokenWrapped.sol
  5. 2
      scripts/prepare-docs.sh

@ -1,11 +1,11 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.2;
import "@openzeppelin/contracts/../governance/Governor.sol";
import "@openzeppelin/contracts/../governance/compatibility/GovernorCompatibilityBravo.sol";
import "@openzeppelin/contracts/../governance/extensions/GovernorVotes.sol";
import "@openzeppelin/contracts/../governance/extensions/GovernorVotesQuorumFraction.sol";
import "@openzeppelin/contracts/../governance/extensions/GovernorTimelockControl.sol";
import "@openzeppelin/contracts/governance/Governor.sol";
import "@openzeppelin/contracts/governance/compatibility/GovernorCompatibilityBravo.sol";
import "@openzeppelin/contracts/governance/extensions/GovernorVotes.sol";
import "@openzeppelin/contracts/governance/extensions/GovernorVotesQuorumFraction.sol";
import "@openzeppelin/contracts/governance/extensions/GovernorTimelockControl.sol";
contract MyGovernor is
Governor,

@ -1,9 +1,9 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.2;
import "@openzeppelin/contracts/../token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Permit.sol";
import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Votes.sol";
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol";
contract MyToken is ERC20, ERC20Permit, ERC20Votes {
constructor() ERC20("MyToken", "MTK") ERC20Permit("MyToken") {}

@ -1,9 +1,9 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.2;
import "@openzeppelin/contracts/../token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Permit.sol";
import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Votes.sol";
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol";
contract MyTokenTimestampBased is ERC20, ERC20Permit, ERC20Votes {
constructor() ERC20("MyTokenTimestampBased", "MTK") ERC20Permit("MyTokenTimestampBased") {}

@ -1,10 +1,10 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.2;
import "@openzeppelin/contracts/../token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Permit.sol";
import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Votes.sol";
import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Wrapper.sol";
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Wrapper.sol";
contract MyTokenWrapped is ERC20, ERC20Permit, ERC20Votes, ERC20Wrapper {
constructor(

@ -20,7 +20,7 @@ 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 -e '/^import/s|\.\./\.\./|@openzeppelin/contracts/|' "$f" > "$examples_target_dir/$name"
sed -Ee '/^import/s|"(\.\./)+|"@openzeppelin/contracts/|' "$f" > "$examples_target_dir/$name"
done
node scripts/gen-nav.js "$OUTDIR" > "$OUTDIR/../nav.adoc"

Loading…
Cancel
Save