docs: generate inventory and stock location references (#5645)
This commit is contained in:
47
docs-util/packages/typedoc-config/inventory.js
Normal file
47
docs-util/packages/typedoc-config/inventory.js
Normal file
@@ -0,0 +1,47 @@
|
||||
/* eslint-disable @typescript-eslint/no-var-requires */
|
||||
const modulesConfig = require("./_modules")
|
||||
|
||||
module.exports = modulesConfig({
|
||||
entryPointPath: "packages/types/src/inventory/service.ts",
|
||||
outPath: "www/apps/docs/content/references/inventory",
|
||||
moduleName: "Inventory Module Reference",
|
||||
documentsToFormat: [
|
||||
{
|
||||
pattern: "*",
|
||||
useDefaults: true,
|
||||
additionalFormatting: {
|
||||
frontmatterData: {
|
||||
displayed_sidebar: "inventoryReference",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
pattern: "IInventoryService/methods",
|
||||
additionalFormatting: {
|
||||
reflectionDescription:
|
||||
"This documentation provides a reference to the `{{alias}}` {{kind}}. This belongs to the Inventory Module.",
|
||||
frontmatterData: {
|
||||
displayed_sidebar: "inventoryReference",
|
||||
slug: "/references/inventory/{{alias}}",
|
||||
sidebar_label: "{{alias}}",
|
||||
},
|
||||
reflectionTitle: {
|
||||
kind: false,
|
||||
typeParameters: false,
|
||||
suffix: "- Inventory Module Reference",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
pattern: "IInventoryService.md",
|
||||
additionalFormatting: {
|
||||
reflectionDescription:
|
||||
"This section of the documentation provides a reference to the `IInventoryService` interface’s methods. This is the interface developers use to use the functionalities provided by the Inventory Module.",
|
||||
frontmatterData: {
|
||||
displayed_sidebar: "inventoryReference",
|
||||
slug: "/references/inventory",
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
47
docs-util/packages/typedoc-config/stock-location.js
Normal file
47
docs-util/packages/typedoc-config/stock-location.js
Normal file
@@ -0,0 +1,47 @@
|
||||
/* eslint-disable @typescript-eslint/no-var-requires */
|
||||
const modulesConfig = require("./_modules")
|
||||
|
||||
module.exports = modulesConfig({
|
||||
entryPointPath: "packages/types/src/stock-location/service.ts",
|
||||
outPath: "www/apps/docs/content/references/stock-location",
|
||||
moduleName: "Stock Location Module Reference",
|
||||
documentsToFormat: [
|
||||
{
|
||||
pattern: "*",
|
||||
useDefaults: true,
|
||||
additionalFormatting: {
|
||||
frontmatterData: {
|
||||
displayed_sidebar: "stockLocationReference",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
pattern: "IStockLocationService/methods",
|
||||
additionalFormatting: {
|
||||
reflectionDescription:
|
||||
"This documentation provides a reference to the `{{alias}}` {{kind}}. This belongs to the Stock Location Module.",
|
||||
frontmatterData: {
|
||||
displayed_sidebar: "stockLocationReference",
|
||||
slug: "/references/stock-location/{{alias}}",
|
||||
sidebar_label: "{{alias}}",
|
||||
},
|
||||
reflectionTitle: {
|
||||
kind: false,
|
||||
typeParameters: false,
|
||||
suffix: "- Stock Location Module Reference",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
pattern: "IStockLocationService.md",
|
||||
additionalFormatting: {
|
||||
reflectionDescription:
|
||||
"This section of the documentation provides a reference to the `IStockLocationService` interface’s methods. This is the interface developers use to use the functionalities provided by the Stock Location Module.",
|
||||
frontmatterData: {
|
||||
displayed_sidebar: "stockLocationReference",
|
||||
slug: "/references/stock-location",
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
Reference in New Issue
Block a user