PowerShell Code documentation

Welcome Forums General PowerShell Q&A PowerShell Code documentation

Viewing 2 reply threads
  • Author
    Posts
    • #276057
      Participant
      Topics: 10
      Replies: 201
      Points: 987
      Helping Hand
      Rank: Major Contributor

      Hello All,

      I have a rather large script/modules that I have been asked to document. They want something more then comments and comment based help. The preferred would be HTML format. A google search led me here:

      https://github.com/msorens/DocTreeGenerator

      I do believe this is exactly what I need, however I am unable to get it working. It always errors that no “NameSpaces” are found. Does anyone out there have any experience with this tool and if so, any ideas on what I am doing wrong?

      Secondly, are there better tools that provide similar results?

      Thanks in advanced for any help/guidance.

    • #276228
      Senior Moderator
      Topics: 9
      Replies: 1449
      Points: 5,428
      Helping Hand
      Rank: Community MVP

      You can try exploring markdown files. It can be rendered as html page as well. Sharepoint and other similar platforms supports markdown files by default.
      You can even generate markdown help docs for PowerShell script/cmdlet/function automatically using https://github.com/PowerShell/platyps

      • This reply was modified 1 month, 2 weeks ago by kvprasoon. Reason: post correction
    • #276285
      Participant
      Topics: 10
      Replies: 201
      Points: 987
      Helping Hand
      Rank: Major Contributor

      @kvprasoon … thank you very much. That worked perfectly 🙂

Viewing 2 reply threads
  • You must be logged in to reply to this topic.