Skip to content

Commit

Permalink
bump typedoc-markdown and regen docs (#398)
Browse files Browse the repository at this point in the history
  • Loading branch information
jaycenhorton authored Nov 30, 2023
1 parent 4c0d342 commit 51542b6
Show file tree
Hide file tree
Showing 58 changed files with 654 additions and 830 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,6 @@
},
"dependencies": {
"typedoc": "0.25.0",
"typedoc-plugin-markdown": "3.13.6"
"typedoc-plugin-markdown": "^3.17.1"
}
}
32 changes: 19 additions & 13 deletions packages/project/docs/interfaces/v3_specification.AnnualCrop.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ if no burning ever occurred, explicitly specify `burningEvent` as `null`

**`Default`**

```ts
{ "type": "no burning" }
```

**`Example`**

<caption>When burning occurred after harvesting:</caption>
Expand All @@ -85,7 +89,7 @@ if no burning ever occurred, explicitly specify `burningEvent` as `null`

#### Defined in

[v3-specification.ts:1014](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1014)
[v3-specification.ts:943](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L943)

___

Expand All @@ -99,7 +103,9 @@ You can find a list of acceptable crop classifications per crop `name` [here](ht

**`Default`**

```ts
"annual crop"
```

**`Example`**

Expand All @@ -109,7 +115,7 @@ You can find a list of acceptable crop classifications per crop `name` [here](ht

#### Defined in

[v3-specification.ts:1253](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1253)
[v3-specification.ts:1160](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1160)

___

Expand Down Expand Up @@ -141,7 +147,7 @@ A list of fertilizer events, if applicable.

#### Defined in

[v3-specification.ts:910](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L910)
[v3-specification.ts:850](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L850)

___

Expand Down Expand Up @@ -177,7 +183,7 @@ during import (explicitly specify null if grazing did not occur, otherwise exclu

#### Defined in

[v3-specification.ts:991](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L991)
[v3-specification.ts:924](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L924)

___

Expand Down Expand Up @@ -208,7 +214,7 @@ that was removed on the grain harvest, regardless of removal date.

#### Defined in

[v3-specification.ts:837](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L837)
[v3-specification.ts:780](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L780)

___

Expand Down Expand Up @@ -238,7 +244,7 @@ A list of irrigation events, if applicable.

#### Defined in

[v3-specification.ts:950](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L950)
[v3-specification.ts:887](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L887)

___

Expand Down Expand Up @@ -273,7 +279,7 @@ during import (explicitly specify null if no liming events occurred, otherwise e

#### Defined in

[v3-specification.ts:970](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L970)
[v3-specification.ts:905](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L905)

___

Expand All @@ -299,7 +305,7 @@ this property will be deprecated in the future

#### Defined in

[v3-specification.ts:784](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L784)
[v3-specification.ts:731](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L731)

___

Expand Down Expand Up @@ -337,7 +343,7 @@ during import (explicitly specify null if no organic matter events occurred, oth

#### Defined in

[v3-specification.ts:933](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L933)
[v3-specification.ts:871](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L871)

___

Expand Down Expand Up @@ -367,7 +373,7 @@ If a crop is ever replanted, define the crop again and add it to a new `CropYear

#### Defined in

[v3-specification.ts:799](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L799)
[v3-specification.ts:744](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L744)

___

Expand Down Expand Up @@ -399,13 +405,13 @@ All crops will need to define a soil or crop disturbance event <= the associated

#### Defined in

[v3-specification.ts:891](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L891)
[v3-specification.ts:832](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L832)

___

### type

**type**: ``"barley"`` \| ``"broccoli-coast"`` \| ``"broccoli-desert"`` \| ``"carrots"`` \| ``"cauliflower"`` \| ``"corn"`` \| ``"corn silage"`` \| ``"cotton"`` \| ``"dry field beans"`` \| ``"dry field pea"`` \| ``"fallow"`` \| ``"lettuce-head"`` \| ``"lettuce-leaf"`` \| ``"lettuce-romaine"`` \| ``"millet"`` \| ``"oats"`` \| ``"rice - flooded"`` \| ``"rye"`` \| ``"sorghum"`` \| ``"sorghum silage"`` \| ``"spring wheat"`` \| ``"sunflower"`` \| ``"switchgrass"`` \| ``"tomatoes, fresh"`` \| ``"tomatoes, processing"`` \| ``"winter wheat"`` \| ``"grass-legume mix"`` \| ``"sugar beets"`` \| ``"strawberry"`` \| ``"peanut"`` \| ``"potato"`` \| ``"soybean"``
**type**: ``"barley"`` \| ``"broccoli-coast"`` \| ``"broccoli-desert"`` \| ``"carrots"`` \| ``"cauliflower"`` \| ``"corn"`` \| ``"corn silage"`` \| ``"cotton"`` \| ``"dry field beans"`` \| ``"dry field pea"`` \| ``"fallow"`` \| ``"grass-legume mix"`` \| ``"lettuce-head"`` \| ``"lettuce-leaf"`` \| ``"lettuce-romaine"`` \| ``"millet"`` \| ``"oats"`` \| ``"peanut"`` \| ``"potato"`` \| ``"rice - flooded"`` \| ``"rye"`` \| ``"sorghum"`` \| ``"sorghum silage"`` \| ``"soybean"`` \| ``"spring wheat"`` \| ``"strawberry"`` \| ``"sugar beets"`` \| ``"sunflower"`` \| ``"switchgrass"`` \| ``"tomatoes, fresh"`` \| ``"tomatoes, processing"`` \| ``"winter wheat"``

The COMET equivalent type of the crop

Expand All @@ -425,4 +431,4 @@ must specify one of the allowed crop types if you are specifying an annual crop

#### Defined in

[v3-specification.ts:1238](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1238)
[v3-specification.ts:1147](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1147)
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ during import (note: when dates are defined as null in an import file, the data

#### Defined in

[v3-specification.ts:1291](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1291)
[v3-specification.ts:1194](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1194)

___

Expand Down Expand Up @@ -115,7 +115,7 @@ during import (specify null if you are unsure)

#### Defined in

[v3-specification.ts:1369](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1369)
[v3-specification.ts:1263](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1263)

___

Expand All @@ -127,7 +127,9 @@ Crop residue removed.

**`Default`**

```ts
0
```

**`Minimum`**

Expand Down Expand Up @@ -167,7 +169,7 @@ Crop residue removed.

#### Defined in

[v3-specification.ts:1397](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1397)
[v3-specification.ts:1286](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1286)

___

Expand All @@ -181,7 +183,9 @@ The current version of quantification does not consider yield when producing est

**`Default`**

```ts
0
```

**`Example`**

Expand All @@ -193,7 +197,7 @@ The current version of quantification does not consider yield when producing est

#### Defined in

[v3-specification.ts:1431](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1431)
[v3-specification.ts:1317](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1317)

___

Expand All @@ -207,7 +211,9 @@ The current version of quantification does not consider yield when producing est

**`Default`**

```ts
"lbs/ac"
```

**`Example`**

Expand All @@ -219,4 +225,4 @@ The current version of quantification does not consider yield when producing est

#### Defined in

[v3-specification.ts:1446](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1446)
[v3-specification.ts:1330](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1330)
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ The type of burning, if applicable.

#### Defined in

[v3-specification.ts:1947](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1947)
[v3-specification.ts:1770](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1770)
30 changes: 18 additions & 12 deletions packages/project/docs/interfaces/v3_specification.CoverCrop.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ if no burning ever occurred, explicitly specify `burningEvent` as `null`

**`Default`**

```ts
{ "type": "no burning" }
```

**`Example`**

<caption>When burning occurred after harvesting:</caption>
Expand All @@ -81,7 +85,7 @@ if no burning ever occurred, explicitly specify `burningEvent` as `null`

#### Defined in

[v3-specification.ts:1014](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1014)
[v3-specification.ts:943](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L943)

___

Expand All @@ -95,7 +99,9 @@ You can find a list of acceptable crop classifications per crop `name` [here](ht

**`Default`**

```ts
"annual cover"
```

**`Example`**

Expand All @@ -105,7 +111,7 @@ You can find a list of acceptable crop classifications per crop `name` [here](ht

#### Defined in

[v3-specification.ts:1201](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1201)
[v3-specification.ts:1113](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1113)

___

Expand Down Expand Up @@ -137,7 +143,7 @@ A list of fertilizer events, if applicable.

#### Defined in

[v3-specification.ts:910](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L910)
[v3-specification.ts:850](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L850)

___

Expand Down Expand Up @@ -173,7 +179,7 @@ during import (explicitly specify null if grazing did not occur, otherwise exclu

#### Defined in

[v3-specification.ts:991](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L991)
[v3-specification.ts:924](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L924)

___

Expand Down Expand Up @@ -203,7 +209,7 @@ A list of irrigation events, if applicable.

#### Defined in

[v3-specification.ts:950](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L950)
[v3-specification.ts:887](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L887)

___

Expand Down Expand Up @@ -238,7 +244,7 @@ during import (explicitly specify null if no liming events occurred, otherwise e

#### Defined in

[v3-specification.ts:970](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L970)
[v3-specification.ts:905](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L905)

___

Expand All @@ -264,7 +270,7 @@ this property will be deprecated in the future

#### Defined in

[v3-specification.ts:784](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L784)
[v3-specification.ts:731](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L731)

___

Expand Down Expand Up @@ -302,7 +308,7 @@ during import (explicitly specify null if no organic matter events occurred, oth

#### Defined in

[v3-specification.ts:933](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L933)
[v3-specification.ts:871](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L871)

___

Expand Down Expand Up @@ -332,7 +338,7 @@ If a crop is ever replanted, define the crop again and add it to a new `CropYear

#### Defined in

[v3-specification.ts:799](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L799)
[v3-specification.ts:744](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L744)

___

Expand Down Expand Up @@ -364,13 +370,13 @@ All crops will need to define a soil or crop disturbance event <= the associated

#### Defined in

[v3-specification.ts:891](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L891)
[v3-specification.ts:832](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L832)

___

### type

**type**: ``"austrian winter pea"`` \| ``"winter grain-other"`` \| ``"annual rye"`` \| ``"annual rye - legume"`` \| ``"annual rye - legume - radish"`` \| ``"cereal rye"`` \| ``"forage radish"`` \| ``"oilseed radish"`` \| ``"vetch"``
**type**: ``"annual rye"`` \| ``"annual rye - legume"`` \| ``"annual rye - legume - radish"`` \| ``"austrian winter pea"`` \| ``"cereal rye"`` \| ``"forage radish"`` \| ``"oilseed radish"`` \| ``"vetch"`` \| ``"winter grain-other"``

The COMET equivalent type of the crop.

Expand All @@ -386,4 +392,4 @@ You can find a list of accepted crops [here](https://go.nori.com/inputs).

#### Defined in

[v3-specification.ts:1186](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1186)
[v3-specification.ts:1100](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1100)
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ during import (note: when dates are defined as null in an import file, the data

#### Defined in

[v3-specification.ts:1291](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1291)
[v3-specification.ts:1194](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1194)
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The last date that the event occurred (formatted as MM/DD/YYYY and YYYY > 2000 a

#### Defined in

[v3-specification.ts:1333](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1333)
[v3-specification.ts:1231](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1231)

___

Expand All @@ -74,4 +74,4 @@ The first date that the event occurred (formatted as MM/DD/YYYY and YYYY > 2000

#### Defined in

[v3-specification.ts:1320](https://github.com/nori-dot-eco/nori-dot-com/blob/475ed1b/packages/project/src/v3-specification.ts#L1320)
[v3-specification.ts:1220](https://github.com/nori-dot-eco/nori-dot-com/blob/4c0d342/packages/project/src/v3-specification.ts#L1220)
Loading

0 comments on commit 51542b6

Please sign in to comment.