Skip to content

Commit d3075b1

Browse files
frankfarzanfrankfarzan
committed
Only generate docs for src/ dir
1 parent 7efef91 commit d3075b1

30 files changed

+755
-904
lines changed

‎docs/develop-quickstart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,4 @@ In order to install these packages, you need to configure your `.npmrc` file to
9090
[install-docker]: https://docs.docker.com/v17.09/engine/installation
9191
[download-kpt]: https://github.com/GoogleContainerTools/kpt
9292
[demo-funcs]: https://github.com/GoogleContainerTools/kpt-functions-sdk/tree/master/ts/demo-functions/src
93-
[api-kptfunc]: ../ts/kpt-functions/docs/interfaces/_src_types_.kptfunc.md
93+
[api-kptfunc]: ../ts/kpt-functions/docs/interfaces/_types_.kptfunc.md

‎docs/develop.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ kpt:type-create Generate classes for core and CRD types. Overwrite
264264
[demo-funcs]: https://github.com/GoogleContainerTools/kpt-functions-sdk/tree/master/ts/demo-functions/src
265265
[label-namespace]: https://github.com/GoogleContainerTools/kpt-functions-sdk/tree/master/ts/demo-functions/src/label_namespace.ts
266266
[catalog]: https://github.com/GoogleContainerTools/kpt-functions-catalog
267-
[api-kptfunc]: ../ts/kpt-functions/docs/interfaces/_src_types_.kptfunc.md
267+
[api-kptfunc]: ../ts/kpt-functions/docs/interfaces/_types_.kptfunc.md
268268
[vscode]: https://code.visualstudio.com/
269269
[npm-packages]: https://github.com/GoogleContainerTools/kpt-functions-sdk/packages
270270
[download-node]: https://nodejs.org/en/download/

‎ts/kpt-functions/docs/README.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66

77
### External modules
88

9-
* ["index"](modules/_index_.md)
10-
* ["src/errors"](modules/_src_errors_.md)
11-
* ["src/metadata"](modules/_src_metadata_.md)
12-
* ["src/run"](modules/_src_run_.md)
13-
* ["src/testing"](modules/_src_testing_.md)
14-
* ["src/types"](modules/_src_types_.md)
9+
* ["errors"](modules/_errors_.md)
10+
* ["metadata"](modules/_metadata_.md)
11+
* ["run"](modules/_run_.md)
12+
* ["testing"](modules/_testing_.md)
13+
* ["types"](modules/_types_.md)

‎ts/kpt-functions/docs/classes/_errors_.configerror.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
[@googlecontainertools/kpt-functions](../README.md) › ["errors"](../modules/_errors_.md) › [ConfigError](_errors_.configerror.md)
2+
3+
# Class: ConfigError
4+
5+
Base class that represent a configuration-related error.
6+
7+
Typically you should use one of the more specific child classes.
8+
9+
## Hierarchy
10+
11+
* [Error](_errors_.configerror.md#static-error)
12+
13+
↳ **ConfigError**
14+
15+
↳ [MultiConfigError](_errors_.multiconfigerror.md)
16+
17+
↳ [ConfigFileError](_errors_.configfileerror.md)
18+
19+
↳ [KubernetesObjectError](_errors_.kubernetesobjecterror.md)
20+
21+
## Index
22+
23+
### Constructors
24+
25+
* [constructor](_errors_.configerror.md#constructor)
26+
27+
### Properties
28+
29+
* [message](_errors_.configerror.md#message)
30+
* [name](_errors_.configerror.md#name)
31+
* [stack](_errors_.configerror.md#optional-stack)
32+
* [Error](_errors_.configerror.md#static-error)
33+
34+
## Constructors
35+
36+
### constructor
37+
38+
\+ **new ConfigError**(`message`: string): *[ConfigError](_errors_.configerror.md)*
39+
40+
**Parameters:**
41+
42+
Name | Type |
43+
------ | ------ |
44+
`message` | string |
45+
46+
**Returns:** *[ConfigError](_errors_.configerror.md)*
47+
48+
## Properties
49+
50+
### message
51+
52+
• **message**: *string*
53+
54+
*Inherited from [ConfigError](_errors_.configerror.md).[message](_errors_.configerror.md#message)*
55+
56+
___
57+
58+
### name
59+
60+
• **name**: *string*
61+
62+
*Inherited from [ConfigError](_errors_.configerror.md).[name](_errors_.configerror.md#name)*
63+
64+
___
65+
66+
### `Optional` stack
67+
68+
• **stack**? : *undefined | string*
69+
70+
*Inherited from [ConfigError](_errors_.configerror.md).[stack](_errors_.configerror.md#optional-stack)*
71+
72+
*Overrides [ConfigError](_errors_.configerror.md).[stack](_errors_.configerror.md#optional-stack)*
73+
74+
___
75+
76+
### `Static` Error
77+
78+
▪ **Error**: *ErrorConstructor*

‎ts/kpt-functions/docs/classes/_errors_.configfileerror.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
[@googlecontainertools/kpt-functions](../README.md) › ["errors"](../modules/_errors_.md) › [ConfigFileError](_errors_.configfileerror.md)
2+
3+
# Class: ConfigFileError
4+
5+
Represents an error with a configuration file.
6+
7+
## Hierarchy
8+
9+
↳ [ConfigError](_errors_.configerror.md)
10+
11+
↳ **ConfigFileError**
12+
13+
## Index
14+
15+
### Constructors
16+
17+
* [constructor](_errors_.configfileerror.md#constructor)
18+
19+
### Properties
20+
21+
* [message](_errors_.configfileerror.md#message)
22+
* [name](_errors_.configfileerror.md#name)
23+
* [path](_errors_.configfileerror.md#path)
24+
* [stack](_errors_.configfileerror.md#optional-stack)
25+
26+
### Methods
27+
28+
* [toString](_errors_.configfileerror.md#tostring)
29+
30+
## Constructors
31+
32+
### constructor
33+
34+
\+ **new ConfigFileError**(`message`: string, `path`: string): *[ConfigFileError](_errors_.configfileerror.md)*
35+
36+
*Overrides [ConfigError](_errors_.configerror.md).[constructor](_errors_.configerror.md#constructor)*
37+
38+
**Parameters:**
39+
40+
Name | Type |
41+
------ | ------ |
42+
`message` | string |
43+
`path` | string |
44+
45+
**Returns:** *[ConfigFileError](_errors_.configfileerror.md)*
46+
47+
## Properties
48+
49+
### message
50+
51+
• **message**: *string*
52+
53+
*Inherited from [ConfigError](_errors_.configerror.md).[message](_errors_.configerror.md#message)*
54+
55+
___
56+
57+
### name
58+
59+
• **name**: *string*
60+
61+
*Inherited from [ConfigError](_errors_.configerror.md).[name](_errors_.configerror.md#name)*
62+
63+
___
64+
65+
### path
66+
67+
• **path**: *string*
68+
69+
___
70+
71+
### `Optional` stack
72+
73+
• **stack**? : *undefined | string*
74+
75+
*Inherited from [ConfigError](_errors_.configerror.md).[stack](_errors_.configerror.md#optional-stack)*
76+
77+
## Methods
78+
79+
### toString
80+
81+
▸ **toString**(): *string*
82+
83+
**Returns:** *string*

‎ts/kpt-functions/docs/classes/_errors_.kubernetesobjecterror.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
[@googlecontainertools/kpt-functions](../README.md) › ["errors"](../modules/_errors_.md) › [KubernetesObjectError](_errors_.kubernetesobjecterror.md)
2+
3+
# Class: KubernetesObjectError
4+
5+
Represents an error with a KubernetesObject.
6+
7+
## Hierarchy
8+
9+
↳ [ConfigError](_errors_.configerror.md)
10+
11+
↳ **KubernetesObjectError**
12+
13+
## Index
14+
15+
### Constructors
16+
17+
* [constructor](_errors_.kubernetesobjecterror.md#constructor)
18+
19+
### Properties
20+
21+
* [message](_errors_.kubernetesobjecterror.md#message)
22+
* [name](_errors_.kubernetesobjecterror.md#name)
23+
* [object](_errors_.kubernetesobjecterror.md#object)
24+
* [stack](_errors_.kubernetesobjecterror.md#optional-stack)
25+
26+
### Methods
27+
28+
* [toString](_errors_.kubernetesobjecterror.md#tostring)
29+
30+
## Constructors
31+
32+
### constructor
33+
34+
\+ **new KubernetesObjectError**(`message`: string, `object`: [KubernetesObject](../interfaces/_types_.kubernetesobject.md)): *[KubernetesObjectError](_errors_.kubernetesobjecterror.md)*
35+
36+
*Overrides [ConfigError](_errors_.configerror.md).[constructor](_errors_.configerror.md#constructor)*
37+
38+
**Parameters:**
39+
40+
Name | Type |
41+
------ | ------ |
42+
`message` | string |
43+
`object` | [KubernetesObject](../interfaces/_types_.kubernetesobject.md) |
44+
45+
**Returns:** *[KubernetesObjectError](_errors_.kubernetesobjecterror.md)*
46+
47+
## Properties
48+
49+
### message
50+
51+
• **message**: *string*
52+
53+
*Inherited from [ConfigError](_errors_.configerror.md).[message](_errors_.configerror.md#message)*
54+
55+
___
56+
57+
### name
58+
59+
• **name**: *string*
60+
61+
*Inherited from [ConfigError](_errors_.configerror.md).[name](_errors_.configerror.md#name)*
62+
63+
___
64+
65+
### object
66+
67+
• **object**: *[KubernetesObject](../interfaces/_types_.kubernetesobject.md)*
68+
69+
___
70+
71+
### `Optional` stack
72+
73+
• **stack**? : *undefined | string*
74+
75+
*Inherited from [ConfigError](_errors_.configerror.md).[stack](_errors_.configerror.md#optional-stack)*
76+
77+
## Methods
78+
79+
### toString
80+
81+
▸ **toString**(): *string*
82+
83+
**Returns:** *string*

‎ts/kpt-functions/docs/classes/_errors_.multiconfigerror.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
[@googlecontainertools/kpt-functions](../README.md) › ["errors"](../modules/_errors_.md) › [MultiConfigError](_errors_.multiconfigerror.md)
2+
3+
# Class: MultiConfigError
4+
5+
Wraps multiple ConfigError objects.
6+
7+
## Hierarchy
8+
9+
↳ [ConfigError](_errors_.configerror.md)
10+
11+
↳ **MultiConfigError**
12+
13+
## Index
14+
15+
### Constructors
16+
17+
* [constructor](_errors_.multiconfigerror.md#constructor)
18+
19+
### Properties
20+
21+
* [errors](_errors_.multiconfigerror.md#errors)
22+
* [message](_errors_.multiconfigerror.md#message)
23+
* [name](_errors_.multiconfigerror.md#name)
24+
* [stack](_errors_.multiconfigerror.md#optional-stack)
25+
26+
### Methods
27+
28+
* [push](_errors_.multiconfigerror.md#push)
29+
* [toString](_errors_.multiconfigerror.md#tostring)
30+
31+
## Constructors
32+
33+
### constructor
34+
35+
\+ **new MultiConfigError**(`message`: string, `errors`: [ConfigError](_errors_.configerror.md)[]): *[MultiConfigError](_errors_.multiconfigerror.md)*
36+
37+
*Overrides [ConfigError](_errors_.configerror.md).[constructor](_errors_.configerror.md#constructor)*
38+
39+
**Parameters:**
40+
41+
Name | Type |
42+
------ | ------ |
43+
`message` | string |
44+
`errors` | [ConfigError](_errors_.configerror.md)[] |
45+
46+
**Returns:** *[MultiConfigError](_errors_.multiconfigerror.md)*
47+
48+
## Properties
49+
50+
### errors
51+
52+
• **errors**: *[ConfigError](_errors_.configerror.md)[]*
53+
54+
___
55+
56+
### message
57+
58+
• **message**: *string*
59+
60+
*Inherited from [ConfigError](_errors_.configerror.md).[message](_errors_.configerror.md#message)*
61+
62+
___
63+
64+
### name
65+
66+
• **name**: *string*
67+
68+
*Inherited from [ConfigError](_errors_.configerror.md).[name](_errors_.configerror.md#name)*
69+
70+
___
71+
72+
### `Optional` stack
73+
74+
• **stack**? : *undefined | string*
75+
76+
*Inherited from [ConfigError](_errors_.configerror.md).[stack](_errors_.configerror.md#optional-stack)*
77+
78+
## Methods
79+
80+
### push
81+
82+
▸ **push**(`error`: [ConfigError](_errors_.configerror.md)): *void*
83+
84+
**Parameters:**
85+
86+
Name | Type |
87+
------ | ------ |
88+
`error` | [ConfigError](_errors_.configerror.md) |
89+
90+
**Returns:** *void*
91+
92+
___
93+
94+
### toString
95+
96+
▸ **toString**(): *string*
97+
98+
**Returns:** *string*

0 commit comments

Comments
 (0)