Skip to content

Commit

Permalink
Merge pull request #48 from umdlife/hotfix/update_documentation
Browse files Browse the repository at this point in the history
Unify build and deploy documentation workflow
  • Loading branch information
biancabnd authored Jan 31, 2024
2 parents 8e1bd67 + 96f8a17 commit f1a191e
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 90 deletions.
69 changes: 69 additions & 0 deletions .github/workflows/build_and_deploy_docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Build and Deploy Documentation on Github Pages

# Runs when PR is closed and merged
on:
push:
branches: ["main"]

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.x # Change this to the Python version your Sphinx project requires

- name: Install dependencies
run: |
python -m pip install --upgrade pip
cd docs
pip install -r requirements.txt # Adjust this if your dependencies are in a different file
- name: Install Doxygen
run: |
cd ..
wget https://www.doxygen.nl/files/doxygen-1.9.7.linux.bin.tar.gz
tar -xzvf doxygen-1.9.7.linux.bin.tar.gz
cd doxygen-1.9.7
sudo make install
- name: Build Documentation
run: |
make -C docs html # This assumes your Sphinx configuration is in a 'docs' folder
- name: Setup Pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: 'docs/_build/html'

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

47 changes: 0 additions & 47 deletions .github/workflows/build_docs.yaml

This file was deleted.

43 changes: 0 additions & 43 deletions .github/workflows/pages-deployment.yml

This file was deleted.

2 changes: 2 additions & 0 deletions psdk_interfaces/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

<depend>std_msgs</depend>
<depend>geometry_msgs</depend>
<depend>std_srvs</depend>


<test_depend>ament_lint_auto</test_depend>
<test_depend>ament_lint_common</test_depend>
Expand Down

0 comments on commit f1a191e

Please sign in to comment.