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

Creating documentation for lib/utils using Travis #7292

Merged
merged 1 commit into from Apr 26, 2019

Conversation

DrMullings
Copy link
Contributor

Using pod2html to create a documentation for lib/utils.pm
Every time lib/utils is changed the documentation for it will be
recreated and redeployed

Preconditions:

  • It needs gh-pages enabled and set to gh-pages branch as source (already done)
  • Needs a Github Token set up in Travis as 'GITHUB_TOKEN'

@foursixnine

@foursixnine
Copy link
Member

@DrMullings So do we proceed with the deploy key?

@DrMullings
Copy link
Contributor Author

Yes, let's go that way

@DrMullings
Copy link
Contributor Author

I think we also need to add docs/ to the master branch because pod2html cannot create it automatically

Using pod2html to create a documentation for lib/utils.pm
Every time lib/utils is changed the documentation for it will be
recreated and redeployed

cd $TRAVIS_BUILD_DIR

touch docs/utils.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DrMullings Let's use this as a stepping stone, but we should have an include list instead... Maybe we can discuss this further in upcomming refinements or directly in some ticket

@foursixnine foursixnine merged commit feedbff into os-autoinst:master Apr 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants