acquire-docs/.github/workflows/deploy_docs.yml at main · acquire-project/acquire-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# This is a basic workflow to help you get started with Actions

name: Build and deploy website

# Controls when the workflow will run
on:
  # Triggers the workflow on push events but only for the "main" branch
  push:
    branches: [ "main" ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build-and-deploy"
  build-and-deploy:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:

      - name: Clone acquire-docs repo
        uses: actions/checkout@v4
        with:
          path: acquire-docs  # place in a named directory

      - uses: actions/setup-python@v4
        with:
          python-version: '3.10'
      - run: pip install -r acquire-docs/requirements.txt

      - name: Generate downloadable scripts
        run: |
          cd acquire-docs
          bash .github/workflows/convert.sh

      - name: Clone acquire-python repo
        uses: actions/checkout@v4
        with:
          path: acquire-python  # place in a named directory
          repository: acquire-project/acquire-python
          submodules: true

      - name: Install acquire-python  # For collecting the API reference
        run: |
          cd acquire-python
          python -m pip install -e .

      - name: Clone acquire-zarr repo
        uses: actions/checkout@v4
        with:
          path: acquire-zarr  # place in a named directory
          repository: acquire-project/acquire-zarr
          submodules: true

      - name: Install Doxygen
        run: sudo apt-get install -y doxygen

      - name: Install vcpkg
        run: |
          git clone https://github.com/microsoft/vcpkg.git
          cd vcpkg && ./bootstrap-vcpkg.sh
          echo "VCPKG_ROOT=${{github.workspace}}/vcpkg" >> $GITHUB_ENV
          echo "${{github.workspace}}/vcpkg" >> $GITHUB_PATH
          ./vcpkg integrate install
        shell: bash

      - name: Install acquire-zarr  # For collecting the API reference
        run: |
          cd acquire-zarr
          python -m pip install pybind11[global]
          python -m pip install .

      - name: Build website
        run: |
          cd acquire-docs
          mkdocs build

      - name: Replace relative links in Doxygen include
        run: |
          # Remove include statements from output files
          sed -i '/<ul>/{N;N;/<ul>\n<li><code>#include \"zarr.types.h\"/d;}' acquire-docs/site/acquire_zarr_c_api/acquire_8zarr_8h/index.html
          sed -i '/<ul>/{N;N;N;N;/<ul>\n<li><code>#include/d;}' acquire-docs/site/acquire_zarr_c_api/zarr_8types_8h/index.html

      - name: Deploy docs
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # external_repository: acquire/acquire-docs.github.io
          publish_dir: acquire-docs/site
          publish_branch: gh-pages
          destination_dir: dev
          # cname: acquire.org