Skip to content

Publish docs

Publish docs #81

Workflow file for this run

name: Publish docs
on:
schedule:
# 04:30 AM (KST) Mon-Fri
- cron: "30 19 * * 0-4"
workflow_dispatch:
jobs:
generate_hotdoc:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install packages for hotdoc
run: |
sudo apt-get install python3-dev libxml2-dev libxslt1-dev cmake libyaml-dev libclang-dev llvm-dev libglib2.0-dev libjson-glib-dev flex
python -m pip install --upgrade pip
pip install hotdoc
- name: Generate doc using hotdoc
run: |
bash Documentation/hotdoc/gen-hotdoc.sh
- name: get date
id: get-date
run: |
echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
- name: Update github.io
uses: ./.github/actions/gitpush
with:
source: ${{ github.workspace }}/Documentation/NNStreamer-doc/html/*
dest: ./
message: "${{ steps.get-date.outputs.date }} : Update nnstreamer.github.io."
taos_account: ${{ secrets.TAOS_ACCOUNT }}
taos_account_token: ${{ secrets.TAOS_ACCOUNT_TOKEN }}
generate_doxybook:
# reference: https://github.com/nnstreamer/TAOS-CI/tree/main/ci/doxybook
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Install packages for doxygen
run: sudo apt-get install doxygen graphviz texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra
- name: Generate doxygen
run: |
doxygen .github/workflows/static.check.scripts/Doxyfile.prj
pushd latex
make -j`nproc`
mv refman.pdf nnstreamer-book.pdf
popd
- name: get date
id: get-date
run: |
echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
- name: Release daily build result to release.nnstreamer.com
uses: ./.github/actions/s3_upload
with:
source: ${{ github.workspace }}/latex/nnstreamer-book.pdf
dest: doc/nnstreamer-book.pdf
s3_id: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
s3_key: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}