platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Published 20 hours ago • verified publisher icon PowerShell

PlatyPS should support creating documentation for DSC Resources

Open clcrutch opened this issue 6 years ago • 3 comments

I have a project I'm using platyPS to generate documentation for existing cmdlets. My module also includes some DSC Resources. I am trying to figure out how to produce docs for those resources, but it seems like platyPS cannot produce docs that look like this. Is there something that I have missed?

clcrutch avatar Aug 10 '18 18:08 clcrutch

Yes, this is missing.

vors avatar Aug 11 '18 20:08 vors

I won't have time in the immediate future, but would you accept a PR that introduces this functionality?

clcrutch avatar Aug 13 '18 18:08 clcrutch

Totally. It seems pretty big in scope, so it's better to discuss your approach before you spend too much time on it. Feel free to outline it here when you have time or hope on gitter channel.

vors avatar Aug 13 '18 18:08 vors

This is really a DSC design issue that needs to be thought about for the DSC v3 release. Please file an issue at https://github.com/PowerShell/DSC/issues/new/choose.

Also, the PowerShell help system doesn't have an object model to support DSC help.

sdwheeler avatar May 31 '24 15:05 sdwheeler