From cdf98d85610f303ec8d109b1d833b6bcc0c50388 Mon Sep 17 00:00:00 2001 From: gretzke Date: Fri, 3 Nov 2023 06:12:27 +0100 Subject: [PATCH] rename directory for autogenerated docs --- .pre-commit-config.yaml | 4 ++-- docs/{html => autogen}/.gitignore | 0 docs/{html => autogen}/book.css | 0 docs/{html => autogen}/book.toml | 0 docs/{html => autogen}/solidity.min.js | 0 docs/{html => autogen}/src/README.md | 0 docs/{html => autogen}/src/SUMMARY.md | 0 .../{html => autogen}/src/src/Counter.sol/contract.Counter.md | 4 ++-- docs/{html => autogen}/src/src/README.md | 0 .../src/src/interface/ICounter.sol/interface.ICounter.md | 4 ++-- .../src/src/interface/IVersioned.sol/interface.IVersioned.md | 2 +- docs/{html => autogen}/src/src/interface/README.md | 0 script/util/doc_gen.sh | 4 ++-- 13 files changed, 9 insertions(+), 9 deletions(-) rename docs/{html => autogen}/.gitignore (100%) rename docs/{html => autogen}/book.css (100%) rename docs/{html => autogen}/book.toml (100%) rename docs/{html => autogen}/solidity.min.js (100%) rename docs/{html => autogen}/src/README.md (100%) rename docs/{html => autogen}/src/SUMMARY.md (100%) rename docs/{html => autogen}/src/src/Counter.sol/contract.Counter.md (84%) rename docs/{html => autogen}/src/src/README.md (100%) rename docs/{html => autogen}/src/src/interface/ICounter.sol/interface.ICounter.md (79%) rename docs/{html => autogen}/src/src/interface/IVersioned.sol/interface.IVersioned.md (82%) rename docs/{html => autogen}/src/src/interface/README.md (100%) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 75613ae..550c23c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -5,7 +5,7 @@ repos: - id: mixed-line-ending args: ["--fix=lf"] description: Forces to replace line ending by the UNIX 'lf' character. - exclude: "^docs/html" + exclude: "^docs/autogen" - repo: local hooks: - id: format @@ -27,4 +27,4 @@ repos: hooks: - id: prettier name: Format non solidity files with prettier - exclude: "^docs/html" + exclude: "^docs/autogen" diff --git a/docs/html/.gitignore b/docs/autogen/.gitignore similarity index 100% rename from docs/html/.gitignore rename to docs/autogen/.gitignore diff --git a/docs/html/book.css b/docs/autogen/book.css similarity index 100% rename from docs/html/book.css rename to docs/autogen/book.css diff --git a/docs/html/book.toml b/docs/autogen/book.toml similarity index 100% rename from docs/html/book.toml rename to docs/autogen/book.toml diff --git a/docs/html/solidity.min.js b/docs/autogen/solidity.min.js similarity index 100% rename from docs/html/solidity.min.js rename to docs/autogen/solidity.min.js diff --git a/docs/html/src/README.md b/docs/autogen/src/README.md similarity index 100% rename from docs/html/src/README.md rename to docs/autogen/src/README.md diff --git a/docs/html/src/SUMMARY.md b/docs/autogen/src/SUMMARY.md similarity index 100% rename from docs/html/src/SUMMARY.md rename to docs/autogen/src/SUMMARY.md diff --git a/docs/html/src/src/Counter.sol/contract.Counter.md b/docs/autogen/src/src/Counter.sol/contract.Counter.md similarity index 84% rename from docs/html/src/src/Counter.sol/contract.Counter.md rename to docs/autogen/src/src/Counter.sol/contract.Counter.md index 48b3a10..34f3ccc 100644 --- a/docs/html/src/src/Counter.sol/contract.Counter.md +++ b/docs/autogen/src/src/Counter.sol/contract.Counter.md @@ -1,8 +1,8 @@ # Counter -[Git Source](https://github.com/0xPolygon/foundry-template/blob/8733bac54bd9be835d614ad4c7c76632d78ceaa0/src/Counter.sol) +[Git Source](https://github.com/0xPolygon/foundry-template/blob/8d1e780e7b907a30a740d7d96eeb5db9fb0b1450/src/Counter.sol) **Inherits:** -[ICounter](/docs/html/src/src/interface/ICounter.sol/interface.ICounter.md) +[ICounter](/docs/autogen/src/src/interface/ICounter.sol/interface.ICounter.md) ## State Variables diff --git a/docs/html/src/src/README.md b/docs/autogen/src/src/README.md similarity index 100% rename from docs/html/src/src/README.md rename to docs/autogen/src/src/README.md diff --git a/docs/html/src/src/interface/ICounter.sol/interface.ICounter.md b/docs/autogen/src/src/interface/ICounter.sol/interface.ICounter.md similarity index 79% rename from docs/html/src/src/interface/ICounter.sol/interface.ICounter.md rename to docs/autogen/src/src/interface/ICounter.sol/interface.ICounter.md index cc824ca..bc6802e 100644 --- a/docs/html/src/src/interface/ICounter.sol/interface.ICounter.md +++ b/docs/autogen/src/src/interface/ICounter.sol/interface.ICounter.md @@ -1,8 +1,8 @@ # ICounter -[Git Source](https://github.com/0xPolygon/foundry-template/blob/8733bac54bd9be835d614ad4c7c76632d78ceaa0/src/interface/ICounter.sol) +[Git Source](https://github.com/0xPolygon/foundry-template/blob/8d1e780e7b907a30a740d7d96eeb5db9fb0b1450/src/interface/ICounter.sol) **Inherits:** -[IVersioned](/docs/html/src/src/interface/IVersioned.sol/interface.IVersioned.md) +[IVersioned](/docs/autogen/src/src/interface/IVersioned.sol/interface.IVersioned.md) ## Functions diff --git a/docs/html/src/src/interface/IVersioned.sol/interface.IVersioned.md b/docs/autogen/src/src/interface/IVersioned.sol/interface.IVersioned.md similarity index 82% rename from docs/html/src/src/interface/IVersioned.sol/interface.IVersioned.md rename to docs/autogen/src/src/interface/IVersioned.sol/interface.IVersioned.md index 8cd147b..f7cf1bb 100644 --- a/docs/html/src/src/interface/IVersioned.sol/interface.IVersioned.md +++ b/docs/autogen/src/src/interface/IVersioned.sol/interface.IVersioned.md @@ -1,5 +1,5 @@ # IVersioned -[Git Source](https://github.com/0xPolygon/foundry-template/blob/8733bac54bd9be835d614ad4c7c76632d78ceaa0/src/interface/IVersioned.sol) +[Git Source](https://github.com/0xPolygon/foundry-template/blob/8d1e780e7b907a30a740d7d96eeb5db9fb0b1450/src/interface/IVersioned.sol) ## Functions diff --git a/docs/html/src/src/interface/README.md b/docs/autogen/src/src/interface/README.md similarity index 100% rename from docs/html/src/src/interface/README.md rename to docs/autogen/src/src/interface/README.md diff --git a/script/util/doc_gen.sh b/script/util/doc_gen.sh index 1010390..5098b44 100755 --- a/script/util/doc_gen.sh +++ b/script/util/doc_gen.sh @@ -1,11 +1,11 @@ #!/bin/bash # generate docs -forge doc -b -o docs/html +forge doc -b -o docs/autogen # Unstage all docs where only the commit hash changed # Get a list of all unstaged files in the directory -files=$(git diff --name-only -- 'docs/html/*') +files=$(git diff --name-only -- 'docs/autogen/*') # Loop over each file for file in $files; do