Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen GitHub action #568

Merged
merged 18 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .github/workflows/update-API-documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Update Documentation on Website

on:
push:
branches:
- master


jobs:
build_and_update_docs:
runs-on: ubuntu-latest
outputs:
libnabo_tag: ${{ steps.step1.outputs.libnabo_tag }}
steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Install dependencies
run: |
sudo apt update
sudo apt install -y build-essential cmake doxygen graphviz libboost-all-dev libeigen3-dev libyaml-cpp-dev

- name: Install libnabo 1) install jq
run: sudo apt install -y jq # Install jq for JSON processing

- name: Install libnabo 2) Get Latest Release Tag
id: get_latest_release
run: |
TAG=$(curl -s https://api.github.com/repos/norlab-ulaval/libnabo/releases/latest | jq -r '.tag_name')
echo "::set-output name=tag::$TAG"

- name: Install libnabo 4) Install libnabo
run: |
git clone -b ${{ steps.get_latest_release.outputs.tag }} https://github.com/norlab-ulaval/libnabo.git
echo "Latest release tag: ${{ steps.get_latest_release.outputs.tag }}"
mkdir -p libnabo/build
cd libnabo/build
cmake ..
sudo make install

- name: Set up libpointmatcher CMake
run: |
mkdir build
cd build
cmake -DGENERATE_API_DOC=TRUE ..

- name: Build Documentation
run: cd build && make doc

- name: Clone website repository
uses: actions/checkout@v2
with:
repository: norlab-ulaval/norlab-ulaval.github.io
path: website
ssh-key: ${{ secrets.NORLAB_WEBSITE_DOCUMENTATION }}
ref: master

- name: Replace documentation files
run: cp -r build/doc/html website/libpointmatcher-doc

- name: Commit and push changes
run: |
cd website
git config --local user.email "actions@github.com"
git config --local user.name "GitHub Actions"
git add libpointmatcher-doc
git commit -m "Update documentation for new release" || exit 0
git push origin HEAD:refs/heads/update-libpointmatcher-docs --force

2 changes: 1 addition & 1 deletion UseDoxygen.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,10 @@ if(DOXYGEN_FOUND AND DOXYFILE_IN_FOUND)

configure_file(${DOXYFILE_IN} Doxyfile IMMEDIATE @ONLY)

get_target_property(DOC_TARGET doc TYPE)
if(NOT DOC_TARGET)
add_custom_target(doc)
endif()
get_target_property(DOC_TARGET doc TYPE)

add_dependencies(doc doxygen)
endif()
4 changes: 2 additions & 2 deletions pointmatcher/Documentation.dox
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
/*!
\mainpage libpointmatcher

from http://github.com/ethz-asl/libpointmatcher by François Pomerleau and Stéphane Magnenat (http://stephane.magnenat.net), ASL-ETHZ, Switzerland (http://www.asl.ethz.ch)
from http://github.com/norlab-ulaval/libpointmatcher by François Pomerleau and Stéphane Magnenat (http://stephane.magnenat.net), ASL-ETHZ, Switzerland (http://www.asl.ethz.ch)

libpointmatcher is a modular ICP library, useful for robotics and computer vision. This help assumes that libpointmatcher is already installed, if not, please read the \c README.md file at the top-level of the source tree.
libpointmatcher is a modular ICP library, useful for robotics and computer vision. This help assumes that libpointmatcher is already installed, if not, please read the \c README.md file at the top-level of the source tree. You can also follow the guide available on https://libpointmatcher.readthedocs.io/en/latest/.

\section Test

Expand Down
Loading