PSHTML icon indicating copy to clipboard operation
PSHTML copied to clipboard

Add automation for documentation

Open Stephanevg opened this issue 6 years ago • 1 comments

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 avatar Jan 10 '19 21:01 Stephanevg

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.

Stephanevg avatar Jul 11 '19 15:07 Stephanevg