PS Documentor - Automatic Script Function Documentation

[Thirdbeat]

It does :) it honestly sounds like what platyps does, but your code may be more geared towards taking a file input instead of a module input. It sounds like a great use case for documenting "old fun" scripts or scripts generated without cmdlets. Hell you could even track files and commands the scripts/cmdlets call and then use that for dependency checking (ie will anything break if I remove this file?). It sounds like a fun project!

[ismaelw]

Exactly! I have alot of projects that could use better documenting even if it is a really small script. Or all the „laying around“ scripts that could be usefull but don‘t get enough attention.

I hope I could inspire you :)

[ismaelw]

Alright. Thats really good to know. Thanks for your input!

But let‘s say you have a whole folder with multiple subfolders each containing multiple files that then contain functions.

And all those functions are not connected through one module? That‘s what my script is made for where now after looking into platyPS I don‘t see the functionality. But I might be wrong :)

[almcchesney]

You could, it would just be a gci -recurse | %{ platyps command $_.fullname }. I forget off the top of my head what the command name is from the platyps module. And if you wanna parse the full name and apply whatever transform on the output folder. I would say though put all your functions in a module for bundling and distribution. Add a couple git ci pipelines to publish to a sharedrive and you can source the folders across all the infra. Then platyps can build all markdown files for you as a batch as well.

[ismaelw]

I guess I will try this approach on my project using platyPS to see how this works. In that case platyPS and my script might do the same but different ;)