From 30d0c0451cf398cba2f5b7cc3525a9f078aed425 Mon Sep 17 00:00:00 2001 From: Lakshman Anumolu Date: Sun, 15 Mar 2020 23:23:06 -0500 Subject: [PATCH] minor changes to cmake and travis build * marked cmake build option for example as advanced, since there are no examples yet. * updated travis to push documentation and coverage to github pages. Signed-off-by: Lakshman Anumolu --- .travis.yml | 12 +++++++++++- CMakeLists.txt | 2 +- README.md | 8 ++++++++ docs/doxygen.mk | 2 +- docs/pages/README.md | 8 ++++++++ 5 files changed, 29 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 08bd297..d7ba818 100644 --- a/.travis.yml +++ b/.travis.yml @@ -47,7 +47,7 @@ before_install: script: - mkdir -p build - cd build - - CC=$INSTALL_CC CXX=$INSTALL_CXX cmake ../ -DMeshIO_BUILD_COVERAGE:BOOL=ON + - CC=$INSTALL_CC CXX=$INSTALL_CXX cmake ../ -DMeshIO_BUILD_COVERAGE:BOOL=ON -DMeshIO_BUILD_DOCS:BOOL=ON - make -j4 - ctest --output-on-failure @@ -57,5 +57,15 @@ after_success: brew install lcov; fi - lcov --directory test --base-directory ../include/meshio/ --capture --no-external --output-file coverage.info + - genhtml coverage.info --output-directory ./docs/html/coverage - lcov --remove coverage.info '/usr*' -o coverage.info - coveralls-lcov coverage.info + +deploy: + provider: pages + skip_cleanup: true + local_dir: ./build/docs/html + github_token: $GH_REPO_TOKEN + on: + branch: master + os: osx diff --git a/CMakeLists.txt b/CMakeLists.txt index d3c91dd..fe8e018 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -64,4 +64,4 @@ install(DIRECTORY "${CMAKE_CURRENT_LIST_DIR}/include" ) mark_as_advanced(MeshIO_BUILD_COVERAGE) -mark_as_advanced(MeshIO_BUILD_DOCS) +mark_as_advanced(MeshIO_BUILD_EXAMPLES) diff --git a/README.md b/README.md index 3bf5ac4..3a4e96f 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,11 @@ Currently supported formats * STL We plan to add support for Wavefront OBJ format next. + +## Documentation + +* [Documentation] +* [Coverage] + +[Documentation]: https://9prady9.github.io/meshio/ +[Coverage]: https://9prady9.github.io/meshio/coverage diff --git a/docs/doxygen.mk b/docs/doxygen.mk index a2c951e..e799f9d 100644 --- a/docs/doxygen.mk +++ b/docs/doxygen.mk @@ -1032,7 +1032,7 @@ HTML_OUTPUT = html # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FILE_EXTENSION = .htm +HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a diff --git a/docs/pages/README.md b/docs/pages/README.md index edd187a..226f847 100644 --- a/docs/pages/README.md +++ b/docs/pages/README.md @@ -15,6 +15,14 @@ A header only library to load/store polygonal meshes. No Examples Written Yet. +## Documentation + +* [Documentation] +* [Coverage] + #### Email * Engineering: pradeep.garigipati@gmail.com; acrlakshman@gmail.com + +[Documentation]: https://9prady9.github.io/meshio/ +[Coverage]: https://9prady9.github.io/meshio/coverage