Skip to content

New-ConfigurationDocumentation.md

Latest commit

 

History

History
224 lines (176 loc) · 5.47 KB

New-ConfigurationDocumentation.md

File metadata and controls

224 lines (176 loc) · 5.47 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

New-ConfigurationDocumentation

SYNOPSIS

Enables or disables creation of documentation from the module using PowerForge.

SYNTAX

__AllParameterSets

New-ConfigurationDocumentation -Path <string> -PathReadme <string> [-Enable] [-SyncExternalHelpToProjectRoot] [-SkipExternalHelp] [-SkipAboutTopics] [-SkipFallbackExamples] [-ExternalHelpCulture <string>] [-ExternalHelpFileName <string>] [-AboutTopicsSourcePath <string[]>] [<CommonParameters>]

DESCRIPTION

This cmdlet emits documentation configuration segments that are consumed by Invoke-ModuleBuild / Build-Module. It controls markdown generation (in -Path), optional external help generation (MAML, e.g. en-US<ModuleName>-help.xml), and project-root documentation sync. When -Enable is used, PowerForge generates documentation, cleans stale files in the configured docs folder, and updates the project documentation path by default.

About topics are supported via about_.help.txt / about_.txt / about_.md / about_.markdown files present in the module source. When enabled, these are converted into markdown pages under Docs\About. Additional source roots can be provided via AboutTopicsSourcePath.

EXAMPLES

EXAMPLE 1

New-ConfigurationDocumentation -Enable -Path 'Docs' -PathReadme 'Docs\Readme.md' -SyncExternalHelpToProjectRoot

EXAMPLE 2

New-ConfigurationDocumentation -Enable -Path 'Docs' -PathReadme 'Docs\Readme.md' -SkipAboutTopics -SkipFallbackExamples

EXAMPLE 3

New-ConfigurationDocumentation -Enable -Path 'Docs' -PathReadme 'Docs\Readme.md' -AboutTopicsSourcePath 'Help\About','Internals\About'

PARAMETERS

-AboutTopicsSourcePath

Optional extra source paths for about_* topic files (.help.txt, .txt, .md, .markdown). Relative paths are resolved from the staging root (for example: 'Help\About').

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Enable

Enables creation of documentation from the module.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ExternalHelpCulture

Culture folder for generated external help (default: en-US).

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ExternalHelpFileName

Optional file name override for external help (default: -help.xml).

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Path

Path to the folder where documentation will be created.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PathReadme

Path to the readme file that will be used for the documentation.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SkipAboutTopics

Disable conversion of about_* topics into markdown pages.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SkipExternalHelp

Disable external help (MAML) generation.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SkipFallbackExamples

Disable generating basic fallback examples for cmdlets missing examples.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SyncExternalHelpToProjectRoot

When enabled, the generated external help file is also synced back to the project root (e.g. en-US<ModuleName>-help.xml).

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • None

OUTPUTS

  • System.Object

RELATED LINKS

  • None