aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/ts/containers/subproviders_documentation.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/website/ts/containers/subproviders_documentation.ts')
-rw-r--r--packages/website/ts/containers/subproviders_documentation.ts85
1 files changed, 3 insertions, 82 deletions
diff --git a/packages/website/ts/containers/subproviders_documentation.ts b/packages/website/ts/containers/subproviders_documentation.ts
index 0e9150d7b..43f06b4ed 100644
--- a/packages/website/ts/containers/subproviders_documentation.ts
+++ b/packages/website/ts/containers/subproviders_documentation.ts
@@ -18,44 +18,19 @@ const LedgerNodeHidMarkdown = require('md/docs/subproviders/ledger_node_hid');
const docSections = {
introduction: 'introduction',
installation: 'installation',
- subprovider: 'subprovider',
- ledgerSubprovider: 'ledgerSubprovider',
ledgerNodeHid: 'ledger-node-hid-issue',
- factoryMethods: 'factory-methods',
- emptyWalletSubprovider: 'emptyWalletSubprovider',
- fakeGasEstimateSubprovider: 'fakeGasEstimateSubprovider',
- injectedWeb3Subprovider: 'injectedWeb3Subprovider',
- signerSubprovider: 'signerSubprovider',
- redundantRPCSubprovider: 'redundantRPCSubprovider',
- ganacheSubprovider: 'ganacheSubprovider',
- nonceTrackerSubprovider: 'nonceTrackerSubprovider',
- privateKeyWalletSubprovider: 'privateKeyWalletSubprovider',
- mnemonicWalletSubprovider: 'mnemonicWalletSubprovider',
- types: docConstants.TYPES_SECTION_NAME,
};
const docsInfoConfig: DocsInfoConfig = {
id: DocPackages.Subproviders,
+ packageName: '@0xproject/subproviders',
type: SupportedDocJson.TypeDoc,
displayName: 'Subproviders',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
+ markdownMenu: {
introduction: [docSections.introduction],
install: [docSections.installation],
- subprovider: [docSections.subprovider],
- ['ledger-subprovider']: [docSections.ledgerSubprovider],
['ledger-node-hid-issue']: [docSections.ledgerNodeHid],
- ['private-key-wallet-subprovider']: [docSections.privateKeyWalletSubprovider],
- ['mnemonic-wallet-subprovider']: [docSections.mnemonicWalletSubprovider],
- ['factory-methods']: [docSections.factoryMethods],
- ['emptyWallet-subprovider']: [docSections.emptyWalletSubprovider],
- ['fakeGasEstimate-subprovider']: [docSections.fakeGasEstimateSubprovider],
- ['injectedWeb3-subprovider']: [docSections.injectedWeb3Subprovider],
- ['signer-subprovider']: [docSections.signerSubprovider],
- ['redundantRPC-subprovider']: [docSections.redundantRPCSubprovider],
- ['ganache-subprovider']: [docSections.ganacheSubprovider],
- ['nonceTracker-subprovider']: [docSections.nonceTrackerSubprovider],
- types: [docSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
@@ -64,61 +39,7 @@ const docsInfoConfig: DocsInfoConfig = {
[docSections.ledgerNodeHid]: LedgerNodeHidMarkdown,
},
},
- sectionNameToModulePath: {
- [docSections.subprovider]: ['"subproviders/src/subproviders/subprovider"'],
- [docSections.ledgerSubprovider]: ['"subproviders/src/subproviders/ledger"'],
- [docSections.privateKeyWalletSubprovider]: ['"subproviders/src/subproviders/private_key_wallet"'],
- [docSections.mnemonicWalletSubprovider]: ['"subproviders/src/subproviders/mnemonic_wallet"'],
- [docSections.factoryMethods]: ['"subproviders/src/index"'],
- [docSections.emptyWalletSubprovider]: ['"subproviders/src/subproviders/empty_wallet_subprovider"'],
- [docSections.fakeGasEstimateSubprovider]: ['"subproviders/src/subproviders/fake_gas_estimate_subprovider"'],
- [docSections.injectedWeb3Subprovider]: ['"subproviders/src/subproviders/injected_web3"'],
- [docSections.signerSubprovider]: ['"subproviders/src/subproviders/signer"'],
- [docSections.redundantRPCSubprovider]: ['"subproviders/src/subproviders/redundant_rpc"'],
- [docSections.ganacheSubprovider]: ['"subproviders/src/subproviders/ganache"'],
- [docSections.nonceTrackerSubprovider]: ['"subproviders/src/subproviders/nonce_tracker"'],
- [docSections.types]: ['"sol-compiler/src/utils/types"', '"types/src/index"', '"subproviders/src/types"'],
- },
- menuSubsectionToVersionWhenIntroduced: {},
- sections: docSections,
- visibleConstructors: [
- docSections.subprovider,
- docSections.ledgerSubprovider,
- docSections.privateKeyWalletSubprovider,
- docSections.mnemonicWalletSubprovider,
- docSections.emptyWalletSubprovider,
- docSections.fakeGasEstimateSubprovider,
- docSections.injectedWeb3Subprovider,
- docSections.redundantRPCSubprovider,
- docSections.ganacheSubprovider,
- docSections.nonceTrackerSubprovider,
- ],
- typeConfigs: {
- // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is
- // currently no way to extract the re-exported types from index.ts via TypeDoc :(
- publicTypes: [
- 'Callback',
- 'NextCallback',
- 'ErrorCallback',
- 'ECSignature',
- 'JSONRPCRequestPayloadWithMethod',
- 'JSONRPCRequestPayload',
- 'JSONRPCResponsePayload',
- 'AccountFetchingConfigs',
- 'LedgerEthereumClientFactoryAsync',
- 'PartialTxParams',
- 'LedgerEthereumClient',
- 'LedgerSubproviderConfigs',
- 'MnemonicWalletSubproviderConfigs',
- 'OnNextCompleted',
- 'Provider',
- ],
- typeNameToExternalLink: {
- Web3: constants.URL_WEB3_DOCS,
- BigNumber: constants.URL_BIGNUMBERJS_GITHUB,
- },
- typeNameToPrefix: {},
- },
+ markdownSections: docSections,
};
const docsInfo = new DocsInfo(docsInfoConfig);