aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/ts/utils/doc_utils.ts
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-26 22:15:53 +0800
committerGitHub <noreply@github.com>2018-09-26 22:15:53 +0800
commit30525d15f468dc084f923b280b265cb8d5fd4975 (patch)
tree35d941998132e83e5f5b830bbe59167f404d6e42 /packages/website/ts/utils/doc_utils.ts
parentc429409ed7a77a67368850f2e736126da0d213dd (diff)
parent2bdaa58d71fb1e62fd07e6bf1be56d841446090b (diff)
downloaddexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar
dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.gz
dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.bz2
dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.lz
dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.xz
dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.zst
dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.zip
Merge pull request #1004 from feuGeneA/sol-doc
[ethereum-types, react-docs, sol-compiler, sol-doc, types, typescript-typings, website] Add new Solidity documentation generation utility
Diffstat (limited to 'packages/website/ts/utils/doc_utils.ts')
-rw-r--r--packages/website/ts/utils/doc_utils.ts4
1 files changed, 2 insertions, 2 deletions
diff --git a/packages/website/ts/utils/doc_utils.ts b/packages/website/ts/utils/doc_utils.ts
index e313648bd..0e1d9ea6e 100644
--- a/packages/website/ts/utils/doc_utils.ts
+++ b/packages/website/ts/utils/doc_utils.ts
@@ -1,4 +1,4 @@
-import { DoxityDocObj, GeneratedDocJson } from '@0xproject/react-docs';
+import { DocAgnosticFormat, GeneratedDocJson } from '@0xproject/react-docs';
import { fetchAsync, logUtils } from '@0xproject/utils';
import * as _ from 'lodash';
import { S3FileObject, VersionToFilePath } from 'ts/types';
@@ -70,7 +70,7 @@ export const docUtils = {
});
return versionFilePaths;
},
- async getJSONDocFileAsync(filePath: string, s3DocJsonRoot: string): Promise<GeneratedDocJson | DoxityDocObj> {
+ async getJSONDocFileAsync(filePath: string, s3DocJsonRoot: string): Promise<GeneratedDocJson | DocAgnosticFormat> {
const endpoint = `${s3DocJsonRoot}/${filePath}`;
const response = await fetchAsync(endpoint);
if (response.status !== 200) {