Skip to content

Commit 91cc00d

Browse files
mxschmittmxschmitt
authored
fix: docs generation on build (#2047)
* fix: docs generation script * docs: updated
1 parent 155a0e1 commit 91cc00d

File tree

8 files changed

+124
-139
lines changed

8 files changed

+124
-139
lines changed

‎docs/calendar_container.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# `calendar_container` (component)
22

3-
| name | type | default value | description |
4-
| ------------ | -------- | ------------- | ----------- |
5-
| `arrowProps` | `object` | `{}` | |
6-
| `children` | `node` | | |
7-
| `className` | `string` | | |
3+
| name | type | default value | description |
4+
| ----------------- | -------- | ------------- | ----------- |
5+
| `arrowProps` | `object` | `{}` | |
6+
| `children` | `node` | | |
7+
| `className` | `string` | | |
8+
| `showPopperArrow` | `bool` | | |

‎docs/index.md

Lines changed: 83 additions & 107 deletions
Large diffs are not rendered by default.

‎docs/inputTime.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# `inputTime` (component)
22

3-
| name | type | default value | description |
4-
| ----------------- | -------- | ------------- | ----------- |
5-
| `onChange` | `func` | | |
6-
| `timeInputLabel` | `string` | | |
7-
| `timeString` | `string` | | |
8-
| `customTimeInput` | `string` | | |
3+
| name | type | default value | description |
4+
| ----------------- | --------- | ------------- | ----------- |
5+
| `customTimeInput` | `element` | | |
6+
| `onChange` | `func` | | |
7+
| `timeInputLabel` | `string` | | |
8+
| `timeString` | `string` | | |

‎docs/popper_component.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
| name | type | default value | description |
44
| ----------------- | --------- | ------------- | ----------- |
55
| `className` | `string` | | |
6+
| `enableTabLoop` | `bool` | | |
67
| `hidePopper` | `bool` | `true` | |
78
| `popperComponent` | `element` | | |
89
| `popperContainer` | `func` | | |
@@ -13,4 +14,4 @@ enabled: true,
1314
escapeWithReference: true,
1415
boundariesElement: "viewport"
1516
}
16-
}`|| |`popperPlacement`|`enumpopperPlacementPositions`|`"bottom-start"`|| |`popperProps`|`object`|`{}`|| |`targetComponent`|`element`|||
17+
}`|| |`popperOnKeyDown`|`func`||| |`popperPlacement`|`enumpopperPlacementPositions`|`"bottom-start"`|| |`popperProps`|`object`|`{}`|| |`targetComponent`|`element`||| |`wrapperClassName`|`string`|||

‎docs/tab_loop.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# `tab_loop` (component)
2+
3+
| name | type | default value | description |
4+
| --------------- | ------ | ------------- | ----------- |
5+
| `children` | `any` | | |
6+
| `enableTabLoop` | `bool` | `true` | |

‎docs/time.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# `time` (component)
22

3-
| name | type | default value | description |
4-
| -------------- | ---------------------- | ------------- | ----------- |
5-
| `excludeTimes` | `array` | | |
6-
| `format` | `string` | | |
7-
| `includeTimes` | `array` | | |
8-
| `injectTimes` | `array` | | |
9-
| `intervals` | `number` | `30` | |
10-
| `locale` | `union(string\|shape)` | | |
11-
| `maxTime` | `instanceOfDate` | | |
12-
| `minTime` | `instanceOfDate` | | |
13-
| `monthRef` | `object` | | |
14-
| `onChange` | `func` | | |
15-
| `onTimeChange` | | `() => {}` | |
16-
| `selected` | `instanceOfDate` | | |
17-
| `timeCaption` | `string` | `"Time"` | |
18-
| `todayButton` | `node` | `null` | |
3+
| name | type | default value | description |
4+
| --------------- | ---------------------- | ------------- | ----------- |
5+
| `excludeTimes` | `array` | | |
6+
| `format` | `string` | | |
7+
| `includeTimes` | `array` | | |
8+
| `injectTimes` | `array` | | |
9+
| `intervals` | `number` | `30` | |
10+
| `locale` | `union(string\|shape)` | | |
11+
| `maxTime` | `instanceOfDate` | | |
12+
| `minTime` | `instanceOfDate` | | |
13+
| `monthRef` | `object` | | |
14+
| `onChange` | `func` | | |
15+
| `onTimeChange` | | `() => {}` | |
16+
| `openToDate` | `instanceOfDate` | | |
17+
| `selected` | `instanceOfDate` | | |
18+
| `timeCaption` | `string` | `"Time"` | |
19+
| `timeClassName` | `func` | | |
20+
| `todayButton` | `node` | `null` | |

‎scripts/buildDocs.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
#!/usr/bin/env node
2-
31
/**
42
* This example script expects a JSON blob generated by react-docgen as input,
53
* e.g. react-docgen components/* | buildDocs.sh

‎scripts/release.sh

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
#!/usr/bin/env bash
22

3+
set -e
4+
35
rm -rf ./node_modules ./lib ./dist
46
yarn
57

68
git checkout .
79

810
npm version $1
911

10-
yarn global add react-docgen
11-
e
12+
npx react-docgen ./src/*.jsx | node ./scripts/buildDocs.js
1213

1314
git add .
1415

0 commit comments

Comments
 (0)