new docs

aragon · Nov 22, 2024 · e32a027 · e32a027
1 parent 4324a09
commit e32a027
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 5 deletions.
diff --git a/contracts/docs/config.js b/contracts/docs/config.js
@@ -5,11 +5,9 @@ const { version, repository } = require('../package.json');
 
 const helpers = require(path.resolve(__dirname, './templates/helpers'));
 
-// TODO: yarn test fails because it runs this file anyways 
-// and helpers is not found.
 // overwrite the functions.
 
-// Tags on `osx-commons-contracts` are created as below.
+// Tags on `osx-commons-contracts` repo are created as below.
 helpers.version = () => `${version}-contracts/contracts`;
 
 helpers.githubURI = () => repository.url;

diff --git a/contracts/hardhat.config.ts b/contracts/hardhat.config.ts
@@ -150,7 +150,7 @@ const config: HardhatUserConfig = {
     outDir: 'typechain',
     target: 'ethers-v5',
   },
-  docgen: require('./docs/config.js'),
+  docgen: process.env.DOCS ? require('./docs/config.js') : undefined,
 };
 
 export default config;
diff --git a/contracts/package.json b/contracts/package.json
@@ -81,6 +81,6 @@
     "test": "hardhat test",
     "typechain": "cross-env TS_NODE_TRANSPILE_ONLY=true hardhat typechain",
     "clean": "rimraf ./artifacts ./cache ./coverage ./typechain ./types ./coverage.json && yarn typechain",
-    "docs": "scripts/prepare-docs.sh"
+    "docs": "DOCS=true scripts/prepare-docs.sh"
   }
 }