crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

BREAKING CHANGE: document contracts from sol-doc

Browse Source 
Change website to accept smart contract documentation in the format
generated by sol-doc rather than that generated by Doxity.
This commit is contained in:
F. Eugene Aumson
2018-09-22 11:06:48 -04:00
parent 9f0dfb1e1a
commit 98d06d6d25
12 changed files with 48 additions and 236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
packages/website/ts/pages/documentation/doc_page.tsx
View File

@@ -1,4 +1,11 @@
import { DocAgnosticFormat, DocsInfo, Documentation } from '@0xproject/react-docs';
import {
DocAgnosticFormat,
DocsInfo,
Documentation,
GeneratedDocJson,
SupportedDocJson,
TypeDocUtils,
} from '@0xproject/react-docs';
import findVersions = require('find-versions');
import * as _ from 'lodash';
import * as React from 'react';
@@ -128,7 +135,22 @@ export class DocPage extends React.Component<DocPageProps, DocPageState> {
const versionFilePathToFetch = versionToFilePath[versionToFetch];
const versionDocObj = await docUtils.getJSONDocFileAsync(versionFilePathToFetch, docBucketRoot);
const docAgnosticFormat = this.props.docsInfo.convertToDocAgnosticFormat(versionDocObj);
let docAgnosticFormat;
if (this.props.docsInfo.type === SupportedDocJson.TypeDoc) {
docAgnosticFormat = new TypeDocUtils(
versionDocObj as GeneratedDocJson,
this.props.docsInfo,
).convertToDocAgnosticFormat();
} else if (this.props.docsInfo.type === SupportedDocJson.Solidity) {
// documenting solidity.
docAgnosticFormat = versionDocObj as DocAgnosticFormat;
// need to modify docsInfo like convertToDocAgnosticFormat() would do
this.props.docsInfo.menu.Contracts = [];
_.each(docAgnosticFormat, (docObj, contractName) => {
this.props.docsInfo.sections[contractName] = contractName;
this.props.docsInfo.menu.Contracts.push(contractName);
});
}
if (!this._isUnmounted) {
this.setState({