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

initial docs up and running #32

Merged
merged 8 commits into from
Nov 6, 2021
Merged
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
25 changes: 11 additions & 14 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,24 @@ jobs:
generate_docs:
runs-on: ubuntu-latest
container:
image: ubuntu:focal
image: rostooling/setup-ros-docker:ubuntu-focal-ros-galactic-ros-base-latest
steps:
- name: setup directories
run: mkdir -p ~/ros_ws/src/bno055
run: mkdir -p ros_ws/src/bno055
- name: checkout
uses: actions/checkout@v2
with:
path: ~/ros_ws/src/bno055
- name: setup ROS environment
uses: ros-tooling/setup-ros@master
with:
install-connext: false
required-ros-distributions: galactic
path: ros_ws/src/bno055
- name: build documentation
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "~/ros_ws/src/bno055/docs/"
pre-build-command: "apt-get update -y && pip3 install -r ~/ros_ws/src/bno055/requirements.txt && pip3 install sphinxcontrib-napoleon"
build-command: '"source /opt/ros/galactic/setup.bash" && "sphinx-build -b html . ./html/"'
run: |
ls
cd ros_ws/src/bno055/docs/
apt-get update -y
pip3 install sphinx sphinxcontrib-napoleon pyserial
. /opt/ros/galactic/setup.sh
sphinx-build -b html . ./html/
- name: deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ~/ros_ws/src/bno055/docs/html/
publish_dir: ros_ws/src/bno055/docs/html/