Skip to content

Commit

Permalink
Set up autogenerated Doxygen documentation via Travis CI
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-k committed Mar 21, 2019
1 parent 8d886a6 commit 81533c0
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
29 changes: 29 additions & 0 deletions .travis.yml
@@ -0,0 +1,29 @@
# This will run on Travis' 'new' container-based infrastructure
sudo: false

# Blacklist
branches:
only:
- master

# Install dependencies
addons:
apt:
packages:
- doxygen
- doxygen-doc
- doxygen-latex
- doxygen-gui
- graphviz

# Build your code e.g. by calling make
script:
- cd $TRAVIS_BUILD_DIR/doc && make

deploy:
provider: pages
skip_cleanup: true
local_dir: doc/html
github_token: $GH_REPO_TOKEN
on:
branch: master
4 changes: 3 additions & 1 deletion README.md
@@ -1,10 +1,12 @@
MatchLib
========
[![Build Status](https://travis-ci.org/NVlabs/matchlib.svg?branch=master)](https://travis-ci.org/NVlabs/matchlib)

MatchLib is a SystemC/C++ library of commonly-used hardware functions and components that can
be synthesized by most commercially-available HLS tools into RTL.

Doxygen-generated documentation can be found here. Additional documentation on the Connections
Doxygen-generated documentation can be found [here](https://NVlabs.github.io/matchlib/).
Additional documentation on the Connections
latency-insensitive channel implementation can be found in the [Connections Guide](doc/connections-guide.pdf).

# Getting Started
Expand Down

0 comments on commit 81533c0

Please sign in to comment.