search

Stephanevg / PSHTML

Cross platform Powershell module to generate HTML markup language
https://pshtml.readthedocs.io/en/latest/
Other
167 stars 43 forks source link

Add automation for documentation #173

Open Stephanevg opened 5 years ago

Stephanevg commented 5 years ago

Use platty PS to automatically generate the documentation.

Open questions:

Should this go in the build of the CI?

If yes: How often should it be build?

ps: I have also linked the /docs section to readtheDocs.io for a more 'professional' documentation --> https://pshtml.readthedocs.io/en/latest/

Stephanevg commented 5 years ago

I had to think about a similar case at work. I tried some stuff out. To make a long story short, it is very difficult to push things back to the Repository from the runner in the CI. therefor I think this step should be delegated locally (for now).

I would recommend adding a script in CI\05_BuildDocumentation.ps1 that wrapps platypus.