doc #715
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
| # Authors: | |
| # Unai Martinez-Corral | |
| # <[email protected]> | |
| # <[email protected]> | |
| # | |
| # Copyright Unai Martinez-Corral | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| # | |
| # SPDX-License-Identifier: Apache-2.0 | |
| name: 'doc' | |
| on: | |
| pull_request: | |
| push: | |
| paths: | |
| - '.github/workflows/doc.yml' | |
| - 'doc/**' | |
| - 'graph/**' | |
| schedule: | |
| - cron: '0 0 * * 4' | |
| workflow_dispatch: | |
| repository_dispatch: | |
| types: [ doc ] | |
| env: | |
| DOCKER_BUILDKIT: 1 | |
| jobs: | |
| image: | |
| runs-on: ubuntu-latest | |
| name: ⛴️ Image | |
| steps: | |
| - name: 🧰 Checkout | |
| uses: actions/checkout@v4 | |
| - name: ⛴️ Build image hdlc/doc:pyHDLC | |
| run: make -C doc pyHDLC | |
| - name: 🛰️ Push container image | |
| if: github.event_name != 'pull_request' && github.repository == 'hdl/containers' | |
| uses: pyTooling/Actions/with-post-step@r0 | |
| with: | |
| main: | | |
| echo '${{ github.token }}' | docker login ghcr.io -u gha --password-stdin | |
| docker push ghcr.io/hdl/containers/doc | |
| post: docker logout docker.io | |
| map: | |
| needs: image | |
| runs-on: ubuntu-latest | |
| name: '🗺️ Map' | |
| steps: | |
| - name: 🧰 Checkout | |
| uses: actions/checkout@v4 | |
| - name: 🗺️ Generate map | |
| run: make -C doc map | |
| - name: '📤 Upload artifact: map' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: Map | |
| path: utils/map.svg | |
| doc: | |
| needs: image | |
| runs-on: ubuntu-latest | |
| name: '📓 Docs' | |
| steps: | |
| - name: 🧰 Checkout | |
| uses: actions/checkout@v4 | |
| - name: 📓 BuildTheDocs (BTD) | |
| uses: buildthedocs/btd@v0 | |
| with: | |
| token: ${{ github.token }} | |
| skip-deploy: ${{ github.event_name == 'pull_request' }} | |
| - name: '📤 Upload artifact: Sphinx HTML' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: Documentation-HTML | |
| path: doc/_build/html |