Merge pull request #1219 from analogdevicesinc/release-main #40
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
| ############################################################################### | |
| # | |
| # Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by | |
| # Analog Devices, Inc.), | |
| # Copyright (C) 2023-2024 Analog Devices, Inc. | |
| # | |
| # 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. | |
| # | |
| ############################################################################## | |
| name: Build & Deploy Docs | |
| # Controls when the workflow will run | |
| on: | |
| push: | |
| branches: [ "release" ] | |
| # 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: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/[email protected] | |
| with: | |
| cache: pip | |
| - name: Install mkdocs | |
| run: pip install -r Documentation/requirements.txt | |
| - name: Doxygen (MAX32520) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32520_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32570) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32570_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32572) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32572_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32650) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32650_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32655) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32655_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32660) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32660_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32662) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32662_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32665) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32665_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32670) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32670_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32672) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32672_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32675) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32675_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32680) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32680_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX32690) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max32690_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX78000) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max78000_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Doxygen (MAX78002) | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: max78002_Doxyfile | |
| # Working directory | |
| working-directory: Libraries/PeriphDrivers/Documentation | |
| - name: Build User Guide | |
| run: | # Build Documentation Folder and run mkdocs | |
| python3 Documentation/build.py | |
| - name: Publish | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs # Deploy the built docs folder |