rename directory for autogenerated docs

0xPolygon · Nov 3, 2023 · cdf98d8 · cdf98d8
1 parent b77f93b
commit cdf98d8
Show file tree

Hide file tree

Showing 13 changed files with 9 additions and 9 deletions.
diff --git 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 → docs/autogen/.gitignore b/docs/html/.gitignore → docs/autogen/.gitignore
diff --git a/docs/html/book.css → docs/autogen/book.css b/docs/html/book.css → docs/autogen/book.css
diff --git a/docs/html/book.toml → docs/autogen/book.toml b/docs/html/book.toml → docs/autogen/book.toml
diff --git a/docs/html/solidity.min.js → docs/autogen/solidity.min.js b/docs/html/solidity.min.js → docs/autogen/solidity.min.js
diff --git a/docs/html/src/README.md → docs/autogen/src/README.md b/docs/html/src/README.md → docs/autogen/src/README.md
diff --git a/docs/html/src/SUMMARY.md → docs/autogen/src/SUMMARY.md b/docs/html/src/SUMMARY.md → docs/autogen/src/SUMMARY.md
diff --git a/...l/src/src/Counter.sol/contract.Counter.md → ...n/src/src/Counter.sol/contract.Counter.md b/...l/src/src/Counter.sol/contract.Counter.md → ...n/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 → docs/autogen/src/src/README.md b/docs/html/src/src/README.md → docs/autogen/src/src/README.md
diff --git a/...erface/ICounter.sol/interface.ICounter.md → ...erface/ICounter.sol/interface.ICounter.md b/...erface/ICounter.sol/interface.ICounter.md → ...erface/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/...ce/IVersioned.sol/interface.IVersioned.md → ...ce/IVersioned.sol/interface.IVersioned.md b/...ce/IVersioned.sol/interface.IVersioned.md → ...ce/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 → docs/autogen/src/src/interface/README.md b/docs/html/src/src/interface/README.md → docs/autogen/src/src/interface/README.md
diff --git 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