Fix getting started page and Python doxygen API #14
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| jobs: | |
| build_documentation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -qq | |
| sudo apt-get install -y -qq python3-sphinx doxygen doxygen-gui doxygen-doc graphviz plantuml tree | |
| # BUILD PACKAGE | |
| . /opt/ros/humble/setup.sh | |
| git config --global --add safe.directory '*' | |
| git submodule update --init --recursive | |
| vcs import . < acados_solver_ros2.repos | |
| tree -L 4 | |
| rosdep install --ignore-src --from-paths . -y -r | |
| colcon build | |
| colcon build | |
| # INSTALL SPHINX PYTHON DEPENDENCIES | |
| cd ./acados_solver_ros2/ | |
| pip install -r requirements.txt | |
| - name: Build documentation | |
| run: | | |
| source install/setup.bash | |
| cd ./acados_solver_ros2 | |
| sphinx-build -b html sphinx sphinx/_build | |
| cd ../ | |
| - name: Create commit | |
| run: | | |
| git clone https://github.com/ICube-Robotics/acados_solver_ros2.git --branch gh-pages --single-branch gh-pages | |
| tree -L 2 # for debg purposes | |
| cd gh-pages && rm -r * && cd .. | |
| mkdir -p gh-pages/docs/ | |
| mkdir -p gh-pages/api/ | |
| cp -r ./acados_solver_ros2/sphinx/_build/* gh-pages/ | |
| cp -r ./acados_solver_ros2/doxygen/_build/html/* gh-pages/api/ | |
| cd gh-pages | |
| touch .nojekyll | |
| git config --local user.email "action@github.com" | |
| git config --local user.name "GitHub Action" | |
| git add . | |
| git commit -m "Update documentation" -a || true | |
| - name: Push changes | |
| uses: ad-m/github-push-action@master | |
| with: | |
| branch: gh-pages | |
| directory: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} |