Skip to content

Commit

Permalink
Fix for typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
roxaneletourneau committed Feb 15, 2021
1 parent 71f0ccc commit 91c3aa1
Show file tree
Hide file tree
Showing 21 changed files with 8,952 additions and 32,132 deletions.
1 change: 1 addition & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
- run: npm run lerna -- bootstrap
- run: npm run build
- run: npm run lint
- run: npm run build-docs
- run: npm run test -- --runInBand
- uses: codecov/codecov-action@v1
with:
Expand Down
2 changes: 2 additions & 0 deletions @nodes/alltypes.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
declare module 'rollup-plugin-json';
declare module 'lodash.camelcase';
40,984 changes: 8,863 additions & 32,121 deletions package-lock.json

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@
"tslint-config-prettier": "^1.18.0",
"tslint-config-standard": "^9.0.0",
"typedoc": "^0.20.23",
"typedoc-plugin-lerna-packages": "^0.3.1",
"typescript": "^4.1.5"
},
"config": {
Expand Down
5 changes: 5 additions & 0 deletions packages/taquito-beacon-wallet/src/taquito-beacon-wallet.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @packageDocumentation
* @module @taquito/beacon-wallet
*/

import {
DAppClient,
DAppClientOptions,
Expand Down
5 changes: 5 additions & 0 deletions packages/taquito-http-utils/src/taquito-http-utils.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @packageDocumentation
* @module @taquito/http-utils
*/

import { STATUS_CODE } from './status_code';

// tslint:disable: strict-type-predicates
Expand Down
5 changes: 5 additions & 0 deletions packages/taquito-ledger-signer/src/taquito-ledger-signer.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @packageDocumentation
* @module @taquito/ledger-signer
*/

import { Signer } from '@taquito/taquito';
import Transport from '@ledgerhq/hw-transport';
import { b58cencode, prefix, Prefix } from '@taquito/utils';
Expand Down
5 changes: 5 additions & 0 deletions packages/taquito-local-forging/src/taquito-local-forging.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @packageDocumentation
* @module @taquito/local-forging
*/

import { ForgeParams, Forger } from '@taquito/taquito';
import { CODEC } from './constants';
import { decoders } from './decoder';
Expand Down
4 changes: 4 additions & 0 deletions packages/taquito-michel-codec/src/taquito-michel-codec.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* @packageDocumentation
* @module @taquito/michel-codec
*/
export * from "./micheline";
export * from "./micheline-parser";
export * from "./micheline-emitter";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @packageDocumentation
* @module @taquito/michelson-encoder
*/

export * from './schema/storage';
export * from './schema/parameter';
export { Semantic } from './tokens/token';
Expand Down
4 changes: 4 additions & 0 deletions packages/taquito-remote-signer/src/taquito-remote-signer.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* @packageDocumentation
* @module @taquito/remote-signer
*/
import { HttpBackend, HttpResponseError, STATUS_CODE } from '@taquito/http-utils';
import {
b58cdecode,
Expand Down
4 changes: 4 additions & 0 deletions packages/taquito-rpc/src/taquito-rpc.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* @packageDocumentation
* @module @taquito/rpc
*/
import { HttpBackend } from '@taquito/http-utils';
import BigNumber from 'bignumber.js';
import {
Expand Down
4 changes: 4 additions & 0 deletions packages/taquito-signer/src/taquito-signer.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* @packageDocumentation
* @module @taquito/signer
*/
import sodium from 'libsodium-wrappers';
import { hex2buf, mergebuf, b58cencode, prefix } from '@taquito/utils';
import toBuffer from 'typedarray-to-buffer';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* @packageDocumentation
* @module @taquito/tezbridge-signer
*/
import { b58cdecode, b58cencode, buf2hex, prefix, isValidPrefix } from '@taquito/utils';
import toBuffer from 'typedarray-to-buffer';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* @packageDocumentation
* @module @taquito/tezbridge-wallet
*/
import {
createOriginationOperation,
createSetDelegateOperation,
Expand Down
4 changes: 4 additions & 0 deletions packages/taquito-tzip12/src/taquito-tzip12.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* @packageDocumentation
* @module @taquito/tzip12
*/
export * from './tzip12-contract-abstraction';
export * from './composer';
export * from './tzip12-errors';
Expand Down
4 changes: 4 additions & 0 deletions packages/taquito-tzip16/src/taquito-tzip16.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* @packageDocumentation
* @module @taquito/tzip16
*/
export * from './handlers/http-handler';
export * from './handlers/tezos-storage-handler';
export * from './handlers/ipfs-handler';
Expand Down
5 changes: 5 additions & 0 deletions packages/taquito-utils/src/taquito-utils.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @packageDocumentation
* @module @taquito/utils
*/

/*
* Some code in this file is originally from sotez and eztz
* Copyright (c) 2018 Andrew Kishino
Expand Down
1 change: 1 addition & 0 deletions packages/taquito/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

[![pkgsign status](https://us-central1-pkgsign.cloudfunctions.net/pkgsign-badge?name=@taquito/taquito&expectedIdentity=%40jevonearth)](https://github.com/RedpointGames/pkgsign)

# Taquito high level functions
Expand Down
5 changes: 5 additions & 0 deletions packages/taquito/src/taquito.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @packageDocumentation
* @module @taquito/taquito
*/

import { RpcClient } from '@taquito/rpc';
import { RPCBatchProvider } from './batch/rpc-batch-provider';
import { Protocols } from './constants';
Expand Down
28 changes: 18 additions & 10 deletions typedoc.js
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
module.exports = {
mode: 'modules',
out: 'dist/typedoc',
readme: 'packages/taquito/README.md',
entryPoints: [
'./packages/taquito/src/taquito.ts',
'./packages/taquito-beacon-wallet/src/taquito-beacon-wallet.ts',
'./packages/taquito-http-utils/src/taquito-http-utils.ts',
'./packages/taquito-ledger-signer/src/taquito-ledger-signer.ts',
'./packages/taquito-local-forging/src/taquito-local-forging.ts',
'./packages/taquito-michelson-encoder/src/taquito-michelson-encoder.ts',
'./packages/taquito-remote-signer/src/taquito-remote-signer.ts',
'./packages/taquito-rpc/src/taquito-rpc.ts',
'./packages/taquito-signer/src/taquito-signer.ts',
'./packages/taquito-tezbridge-signer/src/taquito-tezbridge-signer.ts',
'./packages/taquito-tezbridge-wallet/src/taquito-tezbridge-wallet.ts',
'./packages/taquito-tzip12/src/taquito-tzip12.ts',
'./packages/taquito-tzip16/src/taquito-tzip16.ts',
'./packages/taquito-utils/src/taquito-utils.ts',
],
exclude: [
'**/*.spec.ts',
'**/data/**',
'**/dist/**',
'**/node_modules/**',
'**/rollup*.ts',
'**/test/**',
'example/**/*.ts',
'integration-tests/**/*.ts',
'packages/taquito-michel-codec/formatter/*.ts',
'packages/taquito/example',
'packages/taquito/website',
'website/**/*',
'/coverage/**',
],
lernaExclude: [],
name: 'Taquito',
excludePrivate: true,
excludeNotExported: true
excludePrivate: true
};

0 comments on commit 91c3aa1

Please sign in to comment.