Add Doxygen build to CMake, Travis CI, and doc deployment.

TallJimbo · TallJimbo · commit 3ccaffa52eeb · 2017-03-07T20:51:14.000-08:00
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,27 @@
+sudo: required
+dist: trusty
+language: cpp
+
+before_install:
+  - export PATH=$(echo $PATH | tr ':' "\n" | sed '/\/opt\/python/d' | tr "\n" ":" | sed "s|::|:|g")
+  - sudo apt-get -qq update
+  - sudo apt-get install -y libboost-dev libboost-test-dev libboost-python-dev python-numpy python3-numpy libpython3-dev swig doxygen fftw3-dev libeigen3-dev libpython3-dev
+  - sudo ln -s /usr/lib/x86_64-linux-gnu/libboost_python-py34.so /usr/lib/x86_64-linux-gnu/libboost_python3.so
+
+script:
+  - mkdir build
+  - cd build
+  - cmake -DPYTHON_EXECUTABLE=$PYTHON .. && make && make test ARGS="-V"
+  - make doc
+
+env:
+  - PYTHON=/usr/bin/python
+  - PYTHON=/usr/bin/python3
+
+deploy:
+  provider: pages
+  skip_cleanup: true
+  github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard
+  on:
+    branch: master
+  local_dir: html
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -51,6 +51,18 @@ include_directories(
 
 add_subdirectory(include)
 
+# add a target to generate API documentation with Doxygen
+find_package(Doxygen)
+if(DOXYGEN_FOUND)
+    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.conf.in
+                   ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf @ONLY)
+    add_custom_target(doc ${DOXYGEN_EXECUTABLE}
+                      ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Running Doxygen" VERBATIM
+)
+endif(DOXYGEN_FOUND)
+
 if(NDARRAY_TEST)
 	enable_testing()
 	add_subdirectory(tests)
diff --git a/README.md b/README.md
@@ -1,13 +1,20 @@
+ndarray: NumPy-friendly multidimensional arrays in C++
+======================================================
+[![Build Status](https://travis-ci.org/ndarray/ndarray.svg?branch=master)](https://travis-ci.org/ndarray/ndarray)
+
 ndarray is a template library that provides multidimensional array
 objects in C++, with an interface and features designed to mimic the
 Python 'numpy' package as much as possible.
 
-More information can be found in the Doxygen-generated documentation
+More information can be found in the [documentation at
+ndarray.github.io/ndarray](http://ndarray.github.io/ndarray/).
+
 (which is unhelpfully not built automatically at present...read
 ndarray.h instead).
 
 
-BUILDING FROM GIT
+Building from Git
+-----------------
 
 ndarray includes the Boost.NumPy library using git's "submodules"
 feature.  When you clone the ndarray repository with git, you'll get
@@ -34,11 +41,12 @@ build with cmake, do:
     make
 
 
-BUILDING FROM COMPRESSED SOURCE
+Building from Compressed Source
+-------------------------------
 
 GitHub's automatically generated tarballs and zip files don't include
 the Boost.NumPy submodule or the git metadata needed to run "git
 submodule", so these features can't be used to download ndarray.
 
 When we post release downloads, however, we'll include the Boost.NumPy
-source so they can be built directly.
+source so they can be built directly.
diff --git a/doxygen.conf.in b/doxygen.conf.in
