/documentation

This is the documentation website for AiC Project.

Primary LanguageShell

AiC Documentation

This project contains the index AiC documentation. It is also an example on how to integrate a project with Travis to automatically build the documentation and publish.

How to include a new project to AiC documentation Github pages

For automated publishing you will need to create a deployment key with write access.

To secure the key we encrypt it with travis client. You should follow Travis documentation on Encrypting files.

Add the encrypted file to your repository (for example deploy_key.enc). DO NOT add the original non encrypted key.

Add a .travis.yml with the build and publish instructions.

You can check the script/publish.sh for a script that publishes the documentation build result in a repository. You will need to set several environment variables in Travis to use this script.

References

Auto-deploying built products to gh-pages with Travis

Generating a new SSH key and adding it to the ssh-agent

Auto-deploying Doxygen documentation to gh-pages with Travis CI