push

aragon · Nov 19, 2024 · 59ffafa · 59ffafa
1 parent 9b1ee66
commit 59ffafa
Show file tree

Hide file tree

Showing 9 changed files with 119 additions and 445 deletions.
diff --git a/packages/contracts/docs/config.js b/packages/contracts/docs/config.js
@@ -1,6 +1,14 @@
 const path = require('path');
 const fs = require('fs');
 
+const {version, repository} = require('../package.json');
+
+const helpers = require(path.resolve(__dirname, './templates/helpers'));
+
+// overwrite the functions.
+helpers.version = () => version;
+helpers.githubURI = () => repository.url;
+
 /** @type import('solidity-docgen/dist/config').UserConfig */
 module.exports = {
   outputDir: 'docs/modules/api/pages',
@@ -9,9 +17,6 @@ module.exports = {
   pageExtension: '.adoc',
   collapseNewlines: true,
   pages: (_, file, config) => {
-    const sourcesDir = path.resolve(config.root, config.sourcesDir);
-    let dir = path.resolve(config.root, file.absolutePath);
-
-    return 'TokenVoting' + config.pageExtension;
+    return 'multisig' + config.pageExtension;
   },
 };
diff --git a/packages/contracts/docs/modules/api/nav.adoc b/packages/contracts/docs/modules/api/nav.adoc
@@ -1,2 +1,2 @@
 .API
-* xref:TokenVoting.adoc[Token Voting]
+* xref:multisig.adoc[Multisig]
diff --git a/...s/docs/modules/api/pages/TokenVoting.adoc → ...acts/docs/modules/api/pages/multisig.adoc b/...s/docs/modules/api/pages/TokenVoting.adoc → ...acts/docs/modules/api/pages/multisig.adoc
diff --git a/packages/contracts/docs/templates/contract.hbs b/packages/contracts/docs/templates/contract.hbs
diff --git a/packages/contracts/docs/templates/helpers.js b/packages/contracts/docs/templates/helpers.js
diff --git a/packages/contracts/docs/templates/page.hbs b/packages/contracts/docs/templates/page.hbs
diff --git a/packages/contracts/docs/templates/properties.js b/packages/contracts/docs/templates/properties.js
diff --git a/packages/contracts/package.json b/packages/contracts/package.json
@@ -58,6 +58,10 @@
     "typescript": "^5.2.2",
     "lodash.startcase": "^4.4.0"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aragon/token-voting-plugin"
+  },
   "files": [
     "/src"
   ],