DscResource.DocGenerator

0.5.0-preview0001

Functionality to help generate documentation for modules.

Minimum PowerShell version

5.0

This is a prerelease version of DscResource.DocGenerator.
There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name DscResource.DocGenerator -RequiredVersion 0.5.0-preview0001 -AllowPrerelease

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

DSC Community

Copyright

(c) DSC Community contributors.

Owners

Tags

DSC Modules documentation

Functions

New-DscResourcePowerShellHelp New-DscResourceWikiPage

Dependencies

This module has no dependencies.

Release Notes

## [0.5.0-preview0001] - 2020-03-27

### Fixed

- Fix missing documentation in the README.md for the cmdlet `New-DscResourceWikiPage`
 and the build task `Generate_Wiki_Content` ([issue #20](https://github.com/dsccommunity/DscResource.DocGenerator/issues/20)).
- The function `Get-MofSchemaObject` did not correctly create the temporary
 schema file depending on the formatting of the schema.

## [0.4.0] - 2020-02-25

### Added

- Added build tasks `Generate_Wiki_Content` (that runs the cmdlet
 `New-DscResourceWikiPage`). The build task is primarily meant to be run by
 the project [Sampler's](https://github.com/gaelcolas/Sampler) `build.ps1`.
 To make the task available for `Invoke-Build` in a repository that is based
 on [Sampler](https://github.com/gaelcolas/Sampler) add this module to
 required modules, and then in the `build.yaml` add the following.
 ```yaml
 ModuleBuildTasks:
   DscResource.DocGenerator:
     - 'Task.*'
 ```
 
### Fixed

- Fixes the build task `Generate_Conceptual_Help` to use the correct
 module version folder name for the built module path ([issue #17](https://github.com/dsccommunity/DscResource.DocGenerator/issues/17)).
- Fixes the build task `Generate_Conceptual_Help` to correctly evaluate
 the module version ([issue #21](https://github.com/dsccommunity/DscResource.DocGenerator/issues/21)).

## [0.3.0] - 2020-02-11

### Added

- Added build tasks `Generate_Conceptual_Help` (that runs the cmdlet
 `New-DscResourcePowerShellHelp`). The build task is primarily meant to
 be run by the project [Sampler's](https://github.com/gaelcolas/Sampler)
 `build.ps1`. To make the task available for `Invoke-Build` in a repository
 that is based on [Sampler](https://github.com/gaelcolas/Sampler) add this
 module to required modules, and then in the `build.yaml` add the following.
 ```yaml
 ModuleBuildTasks:
   DscResource.DocGenerator:
     - 'Task.*'
 ```

### Fixed

- Fix the description in the README.md.

## [0.2.0] - 2020-02-06

### Added

- New-DscResourcePowerShellHelp
 - Add new parameter `DestinationModulePath` to be able to set the path
   to a built module (for example) ([issue #9](https://github.com/dsccommunity/DscResource.DocGenerator/issues/9)).

### Fixes

- New-DscResourcePowerShellHelp
 - Fixed comment-based help for the parameter `OutputPath` ([issue #8](https://github.com/dsccommunity/DscResource.DocGenerator/issues/8)).

## [0.1.1] - 2020-02-02

### Added

- Add cmdlet `New-DscResourcePowerShellHelp` to generate conceptual help
 for DSC resources. *This was moved from repo PowerShell/DscResource.Tests.*

### Fixed

- Fixed unit tests to work cross platform.
- Fix status badges in README.md.
- Fix the description in the README.md.

Version History

Version Downloads Last updated
0.10.1 244 10/19/2021
0.10.1-previ... 2 10/18/2021
0.10.1-previ... 3 8/7/2021
0.10.1-previ... 2 8/6/2021
0.10.0 584 8/5/2021
0.10.0-previ... 2 8/5/2021
0.9.1 340 7/14/2021
0.9.1-previe... 2 7/13/2021
0.9.0 46 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/7/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 6/26/2021
0.9.0-previe... 2 6/25/2021
0.9.0-previe... 2 6/20/2021
0.9.0-previe... 2 6/19/2021
0.9.0-previe... 2 6/16/2021
0.9.0-previe... 2 6/8/2021
0.8.4-previe... 2 6/3/2021
0.8.3 1,439 4/10/2021
0.8.2 498 3/19/2021
0.8.1 137 3/11/2021
0.8.1-previe... 4 3/11/2021
0.8.0 514 2/8/2021
0.8.0-previe... 7 2/7/2021
0.7.4 60 2/2/2021
0.7.4-previe... 4 2/2/2021
0.7.3 7 2/2/2021
0.7.3-previe... 4 2/2/2021
0.7.3-previe... 4 1/18/2021
0.7.2 203 1/17/2021
0.7.2-previe... 5 1/17/2021
0.7.1 1,179 8/5/2020
0.7.1-previe... 3 8/5/2020
0.7.0 245 7/8/2020
0.7.0-previe... 3 7/8/2020
0.6.1 117 7/1/2020
0.6.1-previe... 3 7/1/2020
0.6.1-previe... 3 6/26/2020
0.6.0 100 6/22/2020
0.6.0-previe... 3 6/22/2020
0.6.0-previe... 3 6/20/2020
0.5.2-previe... 4 6/16/2020
0.5.1 1,258 5/1/2020
0.5.1-previe... 3 5/1/2020
0.5.0 609 3/28/2020
0.5.0-previe... (current version) 4 3/27/2020
0.4.1-previe... 5 2/26/2020
0.4.0 152 2/25/2020
0.4.0-previe... 5 2/25/2020
0.4.0-previe... 5 2/25/2020
0.4.0-previe... 5 2/18/2020
0.3.0 30 2/11/2020
0.3.0-previe... 5 2/11/2020
0.2.0 10 2/6/2020
0.1.1 7 2/2/2020
0.1.1-previe... 5 2/2/2020
Show less