Git Product home page Git Product logo

documentation's Introduction

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

documentation's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.