Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add automation for documentation #173

Open
Stephanevg opened this issue Jan 10, 2019 · 1 comment
Open

Add automation for documentation #173

Stephanevg opened this issue Jan 10, 2019 · 1 comment
Labels
CI/CD enhancement New feature or request HACKTOBERFEST Issues that could be done by the community. These issues should be quick and easy to implement.
Milestone

Comments

@Stephanevg
Copy link
Owner

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 Stephanevg added enhancement New feature or request CI/CD labels Jan 10, 2019
@Stephanevg Stephanevg added this to the 0.8.1 milestone Jul 9, 2019
@Stephanevg
Copy link
Owner Author

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 Stephanevg added the HACKTOBERFEST Issues that could be done by the community. These issues should be quick and easy to implement. label Oct 1, 2019
@Stephanevg Stephanevg modified the milestones: 0.8.1, 0.8.2 Oct 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD enhancement New feature or request HACKTOBERFEST Issues that could be done by the community. These issues should be quick and easy to implement.
Projects
None yet
Development

No branches or pull requests

1 participant