diff options
| author | F. Eugene Aumson <gene@aumson.org> | 2018-09-22 23:06:48 +0800 |
|---|---|---|
| committer | F. Eugene Aumson <gene@aumson.org> | 2018-09-22 23:29:27 +0800 |
| commit | 98d06d6d252ed379d60bcef915caf38a5ec7a5af (patch) | |
| tree | b68eac94243885495d06e67e70ad8b12a635a517 /packages/website/ts/utils/doc_utils.ts | |
| parent | 9f0dfb1e1a4c97e462cf298e0452be1d0fcf2216 (diff) | |
| download | dexon-0x-contracts-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.gz dexon-0x-contracts-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.zst dexon-0x-contracts-98d06d6d252ed379d60bcef915caf38a5ec7a5af.zip | |
BREAKING CHANGE: document contracts from sol-doc
Change website to accept smart contract documentation in the format
generated by sol-doc rather than that generated by Doxity.
Diffstat (limited to 'packages/website/ts/utils/doc_utils.ts')
| -rw-r--r-- | packages/website/ts/utils/doc_utils.ts | 4 |
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) { |