Skip to content

Commit

Permalink
fix: docs generation on build (Hacker0x01#2047)
Browse files Browse the repository at this point in the history
* fix: docs generation script

* docs: updated
  • Loading branch information
mxschmitt authored Feb 10, 2020
1 parent 155a0e1 commit 91cc00d
Show file tree
Hide file tree
Showing 8 changed files with 124 additions and 139 deletions.
11 changes: 6 additions & 5 deletions docs/calendar_container.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# `calendar_container` (component)

| name | type | default value | description |
| ------------ | -------- | ------------- | ----------- |
| `arrowProps` | `object` | `{}` | |
| `children` | `node` | | |
| `className` | `string` | | |
| name | type | default value | description |
| ----------------- | -------- | ------------- | ----------- |
| `arrowProps` | `object` | `{}` | |
| `children` | `node` | | |
| `className` | `string` | | |
| `showPopperArrow` | `bool` | | |
190 changes: 83 additions & 107 deletions docs/index.md

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/inputTime.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# `inputTime` (component)

| name | type | default value | description |
| ----------------- | -------- | ------------- | ----------- |
| `onChange` | `func` | | |
| `timeInputLabel` | `string` | | |
| `timeString` | `string` | | |
| `customTimeInput` | `string` | | |
| name | type | default value | description |
| ----------------- | --------- | ------------- | ----------- |
| `customTimeInput` | `element` | | |
| `onChange` | `func` | | |
| `timeInputLabel` | `string` | | |
| `timeString` | `string` | | |
3 changes: 2 additions & 1 deletion docs/popper_component.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
| name | type | default value | description |
| ----------------- | --------- | ------------- | ----------- |
| `className` | `string` | | |
| `enableTabLoop` | `bool` | | |
| `hidePopper` | `bool` | `true` | |
| `popperComponent` | `element` | | |
| `popperContainer` | `func` | | |
Expand All @@ -13,4 +14,4 @@ enabled: true,
escapeWithReference: true,
boundariesElement: "viewport"
}
}`|| |`popperPlacement`|`enumpopperPlacementPositions`|`"bottom-start"`|| |`popperProps`|`object`|`{}`|| |`targetComponent`|`element`|||
}`|| |`popperOnKeyDown`|`func`||| |`popperPlacement`|`enumpopperPlacementPositions`|`"bottom-start"`|| |`popperProps`|`object`|`{}`|| |`targetComponent`|`element`||| |`wrapperClassName`|`string`|||
6 changes: 6 additions & 0 deletions docs/tab_loop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# `tab_loop` (component)

| name | type | default value | description |
| --------------- | ------ | ------------- | ----------- |
| `children` | `any` | | |
| `enableTabLoop` | `bool` | `true` | |
34 changes: 18 additions & 16 deletions docs/time.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# `time` (component)

| name | type | default value | description |
| -------------- | ---------------------- | ------------- | ----------- |
| `excludeTimes` | `array` | | |
| `format` | `string` | | |
| `includeTimes` | `array` | | |
| `injectTimes` | `array` | | |
| `intervals` | `number` | `30` | |
| `locale` | `union(string\|shape)` | | |
| `maxTime` | `instanceOfDate` | | |
| `minTime` | `instanceOfDate` | | |
| `monthRef` | `object` | | |
| `onChange` | `func` | | |
| `onTimeChange` | | `() => {}` | |
| `selected` | `instanceOfDate` | | |
| `timeCaption` | `string` | `"Time"` | |
| `todayButton` | `node` | `null` | |
| name | type | default value | description |
| --------------- | ---------------------- | ------------- | ----------- |
| `excludeTimes` | `array` | | |
| `format` | `string` | | |
| `includeTimes` | `array` | | |
| `injectTimes` | `array` | | |
| `intervals` | `number` | `30` | |
| `locale` | `union(string\|shape)` | | |
| `maxTime` | `instanceOfDate` | | |
| `minTime` | `instanceOfDate` | | |
| `monthRef` | `object` | | |
| `onChange` | `func` | | |
| `onTimeChange` | | `() => {}` | |
| `openToDate` | `instanceOfDate` | | |
| `selected` | `instanceOfDate` | | |
| `timeCaption` | `string` | `"Time"` | |
| `timeClassName` | `func` | | |
| `todayButton` | `node` | `null` | |
2 changes: 0 additions & 2 deletions scripts/buildDocs.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
#!/usr/bin/env node

/**
* This example script expects a JSON blob generated by react-docgen as input,
* e.g. react-docgen components/* | buildDocs.sh
Expand Down
5 changes: 3 additions & 2 deletions scripts/release.sh
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
#!/usr/bin/env bash

set -e

rm -rf ./node_modules ./lib ./dist
yarn

git checkout .

npm version $1

yarn global add react-docgen
e
npx react-docgen ./src/*.jsx | node ./scripts/buildDocs.js

git add .

Expand Down

0 comments on commit 91cc00d

Please sign in to comment.